org.forgerock.opendj.ldap.schema

Enum AttributeUsage

java.lang.Object

java.lang.Enum<AttributeUsage>

org.forgerock.opendj.ldap.schema.AttributeUsage

All Implemented Interfaces:

Serializable, Comparable<AttributeUsage>

public enum AttributeUsage
extends Enum<AttributeUsage>

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

See Also:

RFC 2252 - Lightweight Directory Access Protocol (v3): Attribute Syntax Definitions

Enum Constant Summary

Enum Constants

Enum Constant and Description
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

Modifier and Type	Method and Description
boolean	isOperational() Determine whether attributes having this attribute usage are operational.
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, 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 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 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(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

isOperational

public boolean isOperational()

Determine whether attributes having this attribute usage are operational.

Returns:

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

toString

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.