com.unboundid.ldap.sdk.schema
Enum AttributeUsage

java.lang.Object
  extended by java.lang.Enum<AttributeUsage>
      extended by com.unboundid.ldap.sdk.schema.AttributeUsage
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AttributeUsage>

public enum AttributeUsage
extends java.lang.Enum<AttributeUsage>

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


Enum Constant Summary
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
static AttributeUsage forName(java.lang.String name)
          Retrieves the attribute usage value with the specified name.
 java.lang.String getName()
          Retrieves the name of this attribute usage.
 boolean isOperational()
          Indicates whether this is an operational attribute usage.
 java.lang.String toString()
          Retrieves a string representation of this attribute usage.
static AttributeUsage valueOf(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

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 Detail

values

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

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

valueOf

public static AttributeUsage 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 name
java.lang.NullPointerException - if the argument is null

getName

public java.lang.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

public static AttributeUsage forName(java.lang.String name)
Retrieves the attribute usage value with the specified name.

Parameters:
name - The name of the attribute usage to retrieve.
Returns:
The attribute usage with the specified name, or null if there is no usage with the given name.

toString

public java.lang.String toString()
Retrieves a string representation of this attribute usage.

Overrides:
toString in class java.lang.Enum<AttributeUsage>
Returns:
A string representation of this attribute usage.