Enum FacetRange.Include
- java.lang.Object
-
- java.lang.Enum<FacetRange.Include>
-
- com.lucidworks.search.dsl.request.FacetRange.Include
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<FacetRange.Include>
- Enclosing class:
- FacetRange
public static enum FacetRange.Include extends java.lang.Enum<FacetRange.Include>
Flags that specify inclusion and exclusion preferences for the upper and lower bounds of the range
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALL
Includes all optionsEDGE
The "before" and "after" ranges will be inclusive of their bounds, even if the first or last ranges already include those boundaries.LOWER
All gap-based ranges include their lower bound.OUTER
The first and last gap ranges include their edge bounds (lower for the first one, upper for the last one) even if the corresponding upper/lower option is not specified.UPPER
All gap-based ranges include their upper bound.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toString()
static FacetRange.Include
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static FacetRange.Include[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LOWER
public static final FacetRange.Include LOWER
All gap-based ranges include their lower bound.
-
UPPER
public static final FacetRange.Include UPPER
All gap-based ranges include their upper bound.
-
OUTER
public static final FacetRange.Include OUTER
The first and last gap ranges include their edge bounds (lower for the first one, upper for the last one) even if the corresponding upper/lower option is not specified.
-
EDGE
public static final FacetRange.Include EDGE
The "before" and "after" ranges will be inclusive of their bounds, even if the first or last ranges already include those boundaries.
-
ALL
public static final FacetRange.Include ALL
Includes all options
-
-
Method Detail
-
values
public static FacetRange.Include[] 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 (FacetRange.Include c : FacetRange.Include.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FacetRange.Include valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<FacetRange.Include>
-
-