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.

Version:

$Revision: 3120 $ $Date: 2015-10-01 11:50:02 -0400 (Thu, 01 Oct 2015) $

Author:

Middleware Services

Enum Constant Summary

ORDERED
ordered results.

SORTED
sorted results.

UNORDERED
unordered results.

Field Summary

static String

SORT_BEHAVIOR Sort behavior name.

Method Summary

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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

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 name

NullPointerException - if the argument is null

getDefaultSortBehavior

public static SortBehavior getDefaultSortBehavior()

Returns the default sort behavior.

Returns:

default sort behavior