Package org.ldaptive
Enum SortBehavior
- java.lang.Object
-
- java.lang.Enum<SortBehavior>
-
- org.ldaptive.SortBehavior
-
- All Implemented Interfaces:
Serializable
,Comparable<SortBehavior>
public enum SortBehavior extends Enum<SortBehavior>
Enum to define how ldap result, entries, and attribute data should be sorted. Default sort behavior can be controlled with the org.ldaptive.sortBehavior system property. This property must be the fully qualified name of a sort behavior.
-
-
Field Summary
Fields Modifier and Type Field Description private static SortBehavior
defaultSortBehavior
Default sort behavior.private static Logger
LOGGER
Logger for this class.static String
SORT_BEHAVIOR
Sort behavior name.
-
Constructor Summary
Constructors Modifier Constructor Description private
SortBehavior()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SortBehavior
getDefaultSortBehavior()
Returns the default sort behavior.static SortBehavior
valueOf(String name)
Returns the enum constant of this type with the specified name.static SortBehavior[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
UNORDERED
public static final SortBehavior UNORDERED
unordered results.
-
ORDERED
public static final SortBehavior ORDERED
ordered results.
-
SORTED
public static final SortBehavior SORTED
sorted results.
-
-
Field Detail
-
SORT_BEHAVIOR
public static final String SORT_BEHAVIOR
Sort behavior name.- See Also:
- Constant Field Values
-
LOGGER
private static final Logger LOGGER
Logger for this class.
-
defaultSortBehavior
private static SortBehavior defaultSortBehavior
Default sort behavior.
-
-
Method Detail
-
values
public static SortBehavior[] 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 (SortBehavior c : SortBehavior.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SortBehavior 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 nameNullPointerException
- if the argument is null
-
getDefaultSortBehavior
public static SortBehavior getDefaultSortBehavior()
Returns the default sort behavior.- Returns:
- default sort behavior
-
-