Module io.ebean.annotation
Package io.ebean.annotation

Enum DocProperty.Option

java.lang.Object
java.lang.Enum<DocProperty.Option>
io.ebean.annotation.DocProperty.Option
All Implemented Interfaces:
Serializable, Comparable<DocProperty.Option>
Enclosing class:
DocProperty
public static enum DocProperty.Option extends Enum<DocProperty.Option>
Index options for a property.

  • Enum Constant Details

    • DOCS

      public static final DocProperty.Option DOCS
      Only index the doc number.

    • FREQS

      public static final DocProperty.Option FREQS
      Doc number and term frequencies are indexed.

    • POSITIONS

      public static final DocProperty.Option POSITIONS
      Doc number, term frequencies and term positions are indexed.

    • OFFSETS

      public static final DocProperty.Option OFFSETS
      Doc number, term frequencies, term positions and start/end offsets are indexed.

    • DEFAULT

      public static final DocProperty.Option DEFAULT
      Use the default which means analysed string properties use POSITIONS as the default and all other types use DOCS.

  • Method Details

    • values

      public static DocProperty.Option[] 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 DocProperty.Option 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