org.opends.server.admin
Enum PropertyOption

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

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

This enumeration contains various options that can be associated with property definitions.


Enum Constant Summary
ADVANCED
          Use this option to identify properties which should be considered as advanced and should not be exposed by default in client applications.
HIDDEN
          Use this option to identify properties which must not be directly exposed in client applications.
MANDATORY
          Use this option to identify properties which must have a value.
MONITORING
          Use this option to identify properties which are for monitoring purposes only and are generated automatically by the server..
MULTI_VALUED
          Use this option to identify properties which are multi-valued.
READ_ONLY
          Use this option to identify properties which can be initialized once only and are read-only thereafter.
 
Method Summary
static PropertyOption valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PropertyOption[] 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

ADVANCED

public static final PropertyOption ADVANCED
Use this option to identify properties which should be considered as advanced and should not be exposed by default in client applications.


HIDDEN

public static final PropertyOption HIDDEN
Use this option to identify properties which must not be directly exposed in client applications.


MANDATORY

public static final PropertyOption MANDATORY
Use this option to identify properties which must have a value.


MULTI_VALUED

public static final PropertyOption MULTI_VALUED
Use this option to identify properties which are multi-valued.


READ_ONLY

public static final PropertyOption READ_ONLY
Use this option to identify properties which can be initialized once only and are read-only thereafter.


MONITORING

public static final PropertyOption MONITORING
Use this option to identify properties which are for monitoring purposes only and are generated automatically by the server..

Method Detail

values

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

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

valueOf

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