Enum TreeNodeInclusion

java.lang.Object
java.lang.Enum<TreeNodeInclusion>
org.hibernate.search.engine.common.tree.spi.TreeNodeInclusion
All Implemented Interfaces:
Serializable, Comparable<TreeNodeInclusion>

public enum TreeNodeInclusion extends Enum<TreeNodeInclusion>
  • Enum Constant Details

    • INCLUDED

      public static final TreeNodeInclusion INCLUDED
      The node is included. This is the default.

      For index fields, this means field can be populated when indexing and can be referenced in the Search DSL.

    • EXCLUDED

      public static final TreeNodeInclusion EXCLUDED
      The node is excluded. This can only happen because of tree filters, e.g. in @IndexedEmbedded.

      For fields, this means the field can be populated when indexing, but its values will be ignored, and the field cannot be referenced in the Search DSL; trying to reference it in the Search DSL will lead to an exception stating that the field does not exist.

  • Method Details

    • values

      public static TreeNodeInclusion[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static TreeNodeInclusion valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • compose

      public TreeNodeInclusion compose(TreeNodeInclusion childInclusion)