Package org.wildfly.security.auth.realm.ldap

Enum Class DirContextFactory.ReferralMode

java.lang.Object

java.lang.Enum<DirContextFactory.ReferralMode>

org.wildfly.security.auth.realm.ldap.DirContextFactory.ReferralMode

All Implemented Interfaces:

Serializable, Comparable<DirContextFactory.ReferralMode>, Constable

Enclosing interface:

DirContextFactory

public static enum DirContextFactory.ReferralMode
extends Enum<DirContextFactory.ReferralMode>

The referral mode.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FOLLOW	Referrals should be followed.
IGNORE	Referrals should be ignored.
THROW	Referrals should result in an exception.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Get the string value for this referral mode.
boolean	in(DirContextFactory.ReferralMode v1)	Determine whether this instance is equal to one of the given instances.
boolean	in(DirContextFactory.ReferralMode... values)	Determine whether this instance is equal to one of the given instances.
boolean	in(DirContextFactory.ReferralMode v1, DirContextFactory.ReferralMode v2)	Determine whether this instance is equal to one of the given instances.
boolean	in(DirContextFactory.ReferralMode v1, DirContextFactory.ReferralMode v2, DirContextFactory.ReferralMode v3)	Determine whether this instance is equal to one of the given instances.
static boolean	isFull(EnumSet<DirContextFactory.ReferralMode> set)	Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.
String	toString()
static DirContextFactory.ReferralMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DirContextFactory.ReferralMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IGNORE

public static final DirContextFactory.ReferralMode IGNORE

Referrals should be ignored.

FOLLOW

public static final DirContextFactory.ReferralMode FOLLOW

Referrals should be followed.

THROW

public static final DirContextFactory.ReferralMode THROW

Referrals should result in an exception.

Method Details

values

public static DirContextFactory.ReferralMode[] 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

public static DirContextFactory.ReferralMode valueOf(String name)

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 name

NullPointerException - if the argument is null

getValue

public String getValue()

Get the string value for this referral mode.

Returns:

the string value for this referral mode

toString

public String toString()

Overrides:

toString in class Enum<DirContextFactory.ReferralMode>

isFull

public static boolean isFull(EnumSet<DirContextFactory.ReferralMode> set)

Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.

Parameters:

set - the set

Returns:

true if the set is full, false otherwise

in

public boolean in(DirContextFactory.ReferralMode v1)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(DirContextFactory.ReferralMode v1,
 DirContextFactory.ReferralMode v2)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

v2 - the second instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(DirContextFactory.ReferralMode v1,
 DirContextFactory.ReferralMode v2,
 DirContextFactory.ReferralMode v3)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

v2 - the second instance

v3 - the third instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(DirContextFactory.ReferralMode... values)

Determine whether this instance is equal to one of the given instances.

Parameters:

values - the possible values

Returns:

true if one of the instances matches this one, false otherwise