Package org.ldaptive
Enum ReturnAttributes
- java.lang.Object
-
- java.lang.Enum<ReturnAttributes>
-
- org.ldaptive.ReturnAttributes
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ReturnAttributes>
public enum ReturnAttributes extends java.lang.Enum<ReturnAttributes>
Enum to define constants specific to ldap return attributes.- Author:
- Middleware Services
-
-
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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String[]
add(java.lang.String... attrs)
Combines the supplied attributes with the value of this return attributes.boolean
equalsAttributes(java.lang.String... attrs)
Returns whether the supplied attributes matches the value of this return attributes.static java.lang.String[]
parse(java.lang.String... attrs)
java.lang.String[]
value()
Returns the value(s).static ReturnAttributes
valueOf(java.lang.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.
-
-
-
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.
-
-
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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
value
public java.lang.String[] value()
Returns the value(s).- Returns:
- ldap return attribute
-
equalsAttributes
public boolean equalsAttributes(java.lang.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 java.lang.String[] add(java.lang.String... attrs)
Combines the supplied attributes with the value of this return attributes.- Parameters:
attrs
- to combine- Returns:
- combined attributes
-
-