Enum UsageEnum
- java.lang.Object
-
- java.lang.Enum<UsageEnum>
-
- org.apache.directory.api.ldap.model.schema.UsageEnum
-
- All Implemented Interfaces:
Serializable
,Comparable<UsageEnum>
public enum UsageEnum extends Enum<UsageEnum>
Type safe enum for an AttributeType definition's usage string. This can be take one of the following four values:- userApplications
- directoryOperation
- distributedOperation
- dSAOperation
- Author:
- Apache Directory Project
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DIRECTORY_OPERATION
value for attributes with directoryOperation usageDISTRIBUTED_OPERATION
value for attributes with distributedOperation usageDSA_OPERATION
value for attributes with dSAOperation usageUSER_APPLICATIONS
value for attributes with userApplications usage
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UsageEnum
getUsage(String usage)
Gets the enumeration type for the attributeType usage string regardless of case.int
getValue()
String
render()
Get the string representation for UsageEnum, which will be used by the AttributeType renderingstatic String
render(UsageEnum usage)
Get the string representation for UsageEnum, which will be used by the AttributeType renderingstatic UsageEnum
valueOf(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.
-
-
-
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(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 nameNullPointerException
- if the argument is null
-
getValue
public int getValue()
- Returns:
- The value associated with the current element.
-
getUsage
public static UsageEnum getUsage(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 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
-
-