org.apache.directory.shared.ldap.schema
Enum UsageEnum

java.lang.Object
  extended by java.lang.Enum<UsageEnum>
      extended by org.apache.directory.shared.ldap.schema.UsageEnum
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<UsageEnum>

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

Type safe enum for an AttributeType definition's usage string. This can be take one of the following four values:

Version:
$Rev: 896579 $
Author:
Apache Directory Project

Enum Constant Summary
DIRECTORY_OPERATION
          value for attributes with directoryOperation usage
DISTRIBUTED_OPERATION
          value for attributes with distributedOperation usage
DSA_OPERATION
          value for attributes with dSAOperation usage
USER_APPLICATIONS
          value for attributes with userApplications usage
 
Method Summary
static UsageEnum getUsage(java.lang.String usage)
          Gets the enumeration type for the attributeType usage string regardless of case.
 int getValue()
           
 java.lang.String render()
          Get the string representation for UsageEnum, which will be used by the AttributeType rendering
static java.lang.String render(UsageEnum usage)
          Get the string representation for UsageEnum, which will be used by the AttributeType rendering
static UsageEnum valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static UsageEnum[] 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 UsageEnum USER_APPLICATIONS
value for attributes with userApplications usage


DIRECTORY_OPERATION

public static final UsageEnum DIRECTORY_OPERATION
value for attributes with directoryOperation usage


DISTRIBUTED_OPERATION

public static final UsageEnum DISTRIBUTED_OPERATION
value for attributes with distributedOperation usage


DSA_OPERATION

public static final UsageEnum DSA_OPERATION
value for attributes with dSAOperation usage

Method Detail

values

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

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

valueOf

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

getValue

public int getValue()
Returns:
The value associated with the current element.

getUsage

public static UsageEnum getUsage(java.lang.String usage)
Gets the enumeration type for the attributeType usage string regardless of case.

Parameters:
usage - the usage string
Returns:
the usage enumeration type

render

public static java.lang.String render(UsageEnum usage)
Get the string representation for UsageEnum, which will be used by the AttributeType rendering

Parameters:
usage - The UsageEnum of which we want the rendering string
Returns:
The rendering stringe

render

public java.lang.String render()
Get the string representation for UsageEnum, which will be used by the AttributeType rendering

Returns:
The rendering stringe


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.