|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<DereferencePolicy>
org.opends.server.types.DereferencePolicy
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public enum DereferencePolicy
This enumeration defines the set of behaviors that a search operation can exhibit whenever an alias is encountered. This is based on the LDAP specification defined in RFC 2251.
Enum Constant Summary | |
---|---|
DEREF_ALWAYS
The dereference policy that indicates that any dereferences encountered should be dereferenced. |
|
DEREF_FINDING_BASE_OBJECT
The dereference policy that indicates that if the entry specified as the base DN is an alias, it should be dereferenced. |
|
DEREF_IN_SEARCHING
The dereference policy that indicates that any aliases found while looking for candidate entries should be dereferenced. |
|
NEVER_DEREF_ALIASES
The dereference policy that indicates that aliases should never be dereferenced when processing the search. |
Method Summary | |
---|---|
int |
intValue()
Retrieves the integer value associated with this search scope. |
java.lang.String |
toString()
Retrieves a string representation of this alias dereferencing policy. |
static DereferencePolicy |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static DereferencePolicy[] |
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, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final DereferencePolicy NEVER_DEREF_ALIASES
public static final DereferencePolicy DEREF_IN_SEARCHING
public static final DereferencePolicy DEREF_FINDING_BASE_OBJECT
public static final DereferencePolicy DEREF_ALWAYS
Method Detail |
---|
public static DereferencePolicy[] values()
for (DereferencePolicy c : DereferencePolicy.values()) System.out.println(c);
public static DereferencePolicy valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic int intValue()
public java.lang.String toString()
toString
in class java.lang.Enum<DereferencePolicy>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |