org.ldaptive.schema

Enum AttributeUsage

java.lang.Object

java.lang.Enum<AttributeUsage>

org.ldaptive.schema.AttributeUsage

All Implemented Interfaces:

Serializable, Comparable<AttributeUsage>

public enum AttributeUsage
extends Enum<AttributeUsage>

Enum for an attribute usage schema element.

   AttributeUsage =
     "userApplications"     /
     "directoryOperation"   /
     "distributedOperation" / ; DSA-shared
     "dSAOperation"           ; DSA-specific, value depends on server
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIRECTORY_OPERATION directory operation.
DISTRIBUTED_OPERATION distributed operation.
DSA_OPERATION dSA operation.
USER_APPLICATIONS user applications.

Field Summary

Fields

Modifier and Type	Field and Description
private String	name Name of this attribute usage.
private boolean	operational Whether this attribute usage is operational.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name.
boolean	isOperational() Whether this attribute usage is operational.
static AttributeUsage	parse(String s) Returns the attribute usage for the supplied string name.
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, toString, 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

user applications.

DIRECTORY_OPERATION

public static final AttributeUsage DIRECTORY_OPERATION

directory operation.

DISTRIBUTED_OPERATION

public static final AttributeUsage DISTRIBUTED_OPERATION

distributed operation.

DSA_OPERATION

public static final AttributeUsage DSA_OPERATION

dSA operation.

Field Detail

name

private final String name

Name of this attribute usage.

operational

private final boolean operational

Whether this attribute usage is operational.

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

getName

public String getName()

Returns the name.

Returns:

attribute usage name

isOperational

public boolean isOperational()

Whether this attribute usage is operational.

Returns:

whether this attribute usage is operational

parse

public static AttributeUsage parse(String s)

Returns the attribute usage for the supplied string name.

Parameters:

s - case insensitive name to find attribute usage for

Returns:

attribute usage or null if name cannot be found