|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.admin.PropertyDefinition<E>
org.opends.server.admin.EnumPropertyDefinition<E>
E
- The enumeration that should be used for values of this
property definition.public final class EnumPropertyDefinition<E extends java.lang.Enum<E>>
Enumeration property definition.
Nested Class Summary | |
---|---|
static class |
EnumPropertyDefinition.Builder<E extends java.lang.Enum<E>>
An interface for incrementally constructing enumeration property definitions. |
Nested classes/interfaces inherited from class org.opends.server.admin.PropertyDefinition |
---|
PropertyDefinition.AbstractBuilder<T,D extends PropertyDefinition<T>> |
Method Summary | ||
---|---|---|
|
accept(PropertyDefinitionVisitor<R,P> v,
P p)
Apply a visitor to this property definition. |
|
|
accept(PropertyValueVisitor<R,P> v,
E value,
P p)
Apply a visitor to a property value associated with this property definition. |
|
static
|
createBuilder(AbstractManagedObjectDefinition<?,?> d,
java.lang.String propertyName)
Create an enumeration property definition builder. |
|
E |
decodeValue(java.lang.String value)
Parse and validate a string representation of a property value. |
|
java.lang.Class<E> |
getEnumClass()
Get the enumeration class used for values of this property. |
|
Message |
getValueSynopsis(E value)
Gets the synopsis of the specified enumeration value of this enumeration property definition in the default locale. |
|
Message |
getValueSynopsis(java.util.Locale locale,
E value)
Gets the synopsis of the specified enumeration value of this enumeration property definition in the specified locale. |
|
java.lang.String |
normalizeValue(E value)
Get a normalized string representation of a property value. |
|
void |
validateValue(E value)
Determine if the provided property value is valid according to this property definition. |
Methods inherited from class org.opends.server.admin.PropertyDefinition |
---|
castValue, compare, compareTo, encodeValue, equals, getAdministratorAction, getDefaultBehaviorProvider, getDescription, getDescription, getManagedObjectDefinition, getName, getSynopsis, getSynopsis, hashCode, hasOption, initialize, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static <E extends java.lang.Enum<E>> EnumPropertyDefinition.Builder<E> createBuilder(AbstractManagedObjectDefinition<?,?> d, java.lang.String propertyName)
E
- The enumeration that should be used for values of this
property definition.d
- The managed object definition associated with this
property definition.propertyName
- The property name.
public <R,P> R accept(PropertyDefinitionVisitor<R,P> v, P p)
accept
in class PropertyDefinition<E extends java.lang.Enum<E>>
R
- The return type of the visitor's methods.P
- The type of the additional parameters to the visitor's
methods.v
- The property definition visitor.p
- Optional additional visitor parameter.
public <R,P> R accept(PropertyValueVisitor<R,P> v, E value, P p)
accept
in class PropertyDefinition<E extends java.lang.Enum<E>>
R
- The return type of the visitor's methods.P
- The type of the additional parameters to the visitor's
methods.v
- The property value visitor.value
- The property value.p
- Optional additional visitor parameter.
public E decodeValue(java.lang.String value) throws IllegalPropertyValueStringException
decodeValue
in class PropertyDefinition<E extends java.lang.Enum<E>>
value
- The property string value (must not be null
).
IllegalPropertyValueStringException
- If the property value string is invalid.public java.lang.Class<E> getEnumClass()
public final Message getValueSynopsis(E value)
value
- The enumeration value.
public final Message getValueSynopsis(java.util.Locale locale, E value)
value
- The enumeration value.locale
- The locale.
public java.lang.String normalizeValue(E value) throws IllegalPropertyValueException
This method may throw an exception if the provided value is
invalid. However, applications should not assume that
implementations of this method will always validate a value. This
task is the responsibility of PropertyDefinition.validateValue(Object)
.
This default implementation simply returns the string representation of the provided value. Sub-classes might want to override this method if this behavior is insufficient (for example, a string property definition might strip white-space and convert characters to lower-case).
normalizeValue
in class PropertyDefinition<E extends java.lang.Enum<E>>
value
- The property value to be normalized.
IllegalPropertyValueException
- If the property value is invalid.public void validateValue(E value) throws IllegalPropertyValueException
validateValue
in class PropertyDefinition<E extends java.lang.Enum<E>>
value
- The property value (must not be null
).
IllegalPropertyValueException
- If the property value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |