Package org.ldaptive

Enum ReturnAttributes

java.lang.Object

java.lang.Enum<ReturnAttributes>

org.ldaptive.ReturnAttributes

All Implemented Interfaces:

Serializable, Comparable<ReturnAttributes>

public enum ReturnAttributes
extends Enum<ReturnAttributes>

Enum to define constants specific to ldap return attributes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	all user and operational attributes.
ALL_OPERATIONAL	all operational attributes.
ALL_USER	all user attributes.
NONE	no attributes.

Field Summary

Fields

Modifier and Type	Field	Description
private String[]	value	underlying value.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ReturnAttributes(String[] s)	Creates a new return attributes.

Method Summary

Modifier and Type	Method	Description
String[]	add(String... attrs)	Combines the supplied attributes with the value of this return attributes.
boolean	equalsAttributes(String... attrs)	Returns whether the supplied attributes matches the value of this return attributes.
static String[]	parse(String... attrs)	Parses the supplied return attributes and applies the following convention: null == ALL_USER empty == ALL_USER
String[]	value()	Returns the value(s).
static ReturnAttributes	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReturnAttributes[]	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

ALL

public static final ReturnAttributes ALL

all user and operational attributes.

ALL_USER

public static final ReturnAttributes ALL_USER

all user attributes.

ALL_OPERATIONAL

public static final ReturnAttributes ALL_OPERATIONAL

all operational attributes.

NONE

public static final ReturnAttributes NONE

no attributes.

Field Detail

value

private final String[] value

underlying value.

Constructor Detail

ReturnAttributes

private ReturnAttributes(String[] s)

Creates a new return attributes.

Parameters:

s - value

Method Detail

values

public static ReturnAttributes[] 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 (ReturnAttributes c : ReturnAttributes.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReturnAttributes 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

value

public String[] value()

Returns the value(s).

Returns:

ldap return attribute

equalsAttributes

public boolean equalsAttributes(String... attrs)

Returns whether the supplied attributes matches the value of this return attributes.

Parameters:

attrs - to compare

Returns:

whether attrs contains only this return attributes

add

public String[] add(String... attrs)

Combines the supplied attributes with the value of this return attributes.

Parameters:

attrs - to combine

Returns:

combined attributes

parse

public static String[] parse(String... attrs)

Parses the supplied return attributes and applies the following convention:

• null == ALL_USER
• empty == ALL_USER

Parameters:

attrs - to parse

Returns:

parsed attributes according to convention