Package org.apache.lucene.index
Enum Class FilteredTermsEnum.AcceptStatus
java.lang.Object
java.lang.Enum<FilteredTermsEnum.AcceptStatus>
org.apache.lucene.index.FilteredTermsEnum.AcceptStatus
- All Implemented Interfaces:
Serializable
,Comparable<FilteredTermsEnum.AcceptStatus>
,Constable
- Enclosing class:
- FilteredTermsEnum
Return value, if term should be accepted or the iteration should
END
. The
*_SEEK
values denote, that after handling the current term the enum should call FilteredTermsEnum.nextSeekTerm(org.apache.lucene.util.BytesRef)
and step forward.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionReject the term and stop enumerating.Reject the term and position the enum at the next term.Reject the term and advance (FilteredTermsEnum.nextSeekTerm(BytesRef)
) to the next term.Accept the term and position the enum at the next term.Accept the term and advance (FilteredTermsEnum.nextSeekTerm(BytesRef)
) to the next term. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.static FilteredTermsEnum.AcceptStatus[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
YES
Accept the term and position the enum at the next term. -
YES_AND_SEEK
Accept the term and advance (FilteredTermsEnum.nextSeekTerm(BytesRef)
) to the next term. -
NO
Reject the term and position the enum at the next term. -
NO_AND_SEEK
Reject the term and advance (FilteredTermsEnum.nextSeekTerm(BytesRef)
) to the next term. -
END
Reject the term and stop enumerating.
-
-
Constructor Details
-
AcceptStatus
private AcceptStatus()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-