Package org.ldaptive
Enum Class ReturnAttributes
- All Implemented Interfaces:
Serializable
,Comparable<ReturnAttributes>
,Constable
Enum to define constants specific to ldap return attributes.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionall user and operational attributes.all operational attributes.all user attributes.no attributes. -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
ReturnAttributes
(String[] s) Creates a new return attributes. -
Method Summary
Modifier and TypeMethodDescriptionString[]
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[]
String[]
value()
Returns the value(s).static ReturnAttributes
Returns the enum constant of this class with the specified name.static ReturnAttributes[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ALL
all user and operational attributes. -
ALL_USER
all user attributes. -
ALL_OPERATIONAL
all operational attributes. -
NONE
no attributes.
-
-
Field Details
-
value
underlying value.
-
-
Constructor Details
-
ReturnAttributes
Creates a new return attributes.- Parameters:
s
- value
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
value
Returns the value(s).- Returns:
- ldap return attribute
-
equalsAttributes
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
Combines the supplied attributes with the value of this return attributes.- Parameters:
attrs
- to combine- Returns:
- combined attributes
-
parse
Parses the supplied return attributes and applies the following convention:- Parameters:
attrs
- to parse- Returns:
- parsed attributes according to convention
-