Package com.unboundid.ldap.sdk.schema

Enum AttributeUsage

java.lang.Object

java.lang.Enum<AttributeUsage>

com.unboundid.ldap.sdk.schema.AttributeUsage

All Implemented Interfaces:

Serializable, Comparable<AttributeUsage>, java.lang.constant.Constable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum AttributeUsage
extends Enum<AttributeUsage>

This enum defines the set of attribute type usages that are defined in the LDAP protocol.

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
DIRECTORY_OPERATION	The "directoryOperation" attribute usage.
DISTRIBUTED_OPERATION	The "distributedOperation" attribute usage.
DSA_OPERATION	The "dSAOperation" attribute usage.
USER_APPLICATIONS	The "userApplications" attribute usage.

Method Summary

Modifier and Type	Method	Description
static AttributeUsage	forName(String name)	Retrieves the attribute usage value with the specified name.
String	getName()	Retrieves the name of this attribute usage.
boolean	isOperational()	Indicates whether this is an operational attribute usage.
String	toString()	Retrieves a string representation of this attribute usage.
static AttributeUsage	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AttributeUsage[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USER_APPLICATIONS

public static final AttributeUsage USER_APPLICATIONS

The "userApplications" attribute usage.

DIRECTORY_OPERATION

public static final AttributeUsage DIRECTORY_OPERATION

The "directoryOperation" attribute usage.

DISTRIBUTED_OPERATION

public static final AttributeUsage DISTRIBUTED_OPERATION

The "distributedOperation" attribute usage.

DSA_OPERATION

public static final AttributeUsage DSA_OPERATION

The "dSAOperation" attribute usage.

Method Details

values

public static AttributeUsage[] values()

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

Returns:

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

valueOf

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

getName

@NotNull
public String getName()

Retrieves the name of this attribute usage.

Returns:

The name of this attribute usage.

isOperational

public boolean isOperational()

Indicates whether this is an operational attribute usage.

Returns:

true if this is an operational attribute usage.

forName

@Nullable
public static AttributeUsage forName(@NotNull
 String name)

Retrieves the attribute usage value with the specified name.

Parameters:

name - The name of the attribute usage to retrieve. It must not be null.

Returns:

The attribute usage with the specified name, or null if there is no usage with the given name.

toString

@NotNull
public String toString()

Retrieves a string representation of this attribute usage.

Overrides:

toString in class Enum<AttributeUsage>

Returns:

A string representation of this attribute usage.