Package org.hibernate.search.engine.backend.document.model.spi

Enum IndexFieldInclusion

    • Enum Constant Detail

      • INCLUDED

        public static final IndexFieldInclusion INCLUDED
        The field is included. This is the default.

        The field can be populated when indexing and can be referenced in the Search DSL.

      • EXCLUDED

        public static final IndexFieldInclusion EXCLUDED
        The field is excluded. This can only happen because of @IndexedEmbedded filters.

        The field can be populated when indexing, but its values will be ignored.

        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 Detail

      • values

        public static IndexFieldInclusion[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (IndexFieldInclusion c : IndexFieldInclusion.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static IndexFieldInclusion 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