org.opends.server.types
Enum AttributeUsage

java.lang.Object
  extended by java.lang.Enum<AttributeUsage>
      extended by org.opends.server.types.AttributeUsage
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AttributeUsage>

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public enum AttributeUsage
extends java.lang.Enum<AttributeUsage>

This enumeration defines the set of possible attribute usage values that may apply to an attribute type, as defined in RFC 2252.


Enum Constant Summary
DIRECTORY_OPERATION
          The attribute usage intended for standard operational attributes.
DISTRIBUTED_OPERATION
          The attribute usage intended for non-standard operational attributes shared among multiple DSAs.
DSA_OPERATION
          The attribute usage intended for non-standard operational attributes used by a single DSA.
USER_APPLICATIONS
          The attribute usage intended for user-defined attribute types.
 
Method Summary
 boolean isOperational()
          Determine whether or not attributes having this attribute usage are operational.
 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're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

USER_APPLICATIONS

public static final AttributeUsage USER_APPLICATIONS
The attribute usage intended for user-defined attribute types.


DIRECTORY_OPERATION

public static final AttributeUsage DIRECTORY_OPERATION
The attribute usage intended for standard operational attributes.


DISTRIBUTED_OPERATION

public static final AttributeUsage DISTRIBUTED_OPERATION
The attribute usage intended for non-standard operational attributes shared among multiple DSAs.


DSA_OPERATION

public static final AttributeUsage DSA_OPERATION
The attribute usage intended for non-standard operational attributes used by a single DSA.

Method Detail

values

public static final AttributeUsage[] values()
Returns an array containing the constants of this enum type, in the order they're 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're 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

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.

isOperational

public boolean isOperational()
Determine whether or not attributes having this attribute usage are operational.

Returns:
Returns true if attributes having this attribute usage are operational, or false otherwise.