Package org.forgerock.opendj.config

Class EnumPropertyDefinition<E extends Enum<E>>

java.lang.Object

org.forgerock.opendj.config.PropertyDefinition<E>

org.forgerock.opendj.config.EnumPropertyDefinition<E>

Type Parameters:

E - The enumeration that should be used for values of this property definition.

All Implemented Interfaces:

Comparable<PropertyDefinition<?>>, Comparator<ValueOrExpression<E>>

public final class EnumPropertyDefinition<E extends Enum<E>>
extends PropertyDefinition<E>

Enumeration property definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnumPropertyDefinition.Builder<E extends Enum<E>>	An interface for incrementally constructing enumeration property definitions.

Nested classes/interfaces inherited from class org.forgerock.opendj.config.PropertyDefinition

PropertyDefinition.AbstractBuilder<T,D extends PropertyDefinition<T>>

Method Summary

Modifier and Type	Method	Description
<R,P> R	accept(PropertyDefinitionVisitor<R,P> v, P p)	Apply a visitor to this property definition.
<R,P> R	accept(PropertyValueVisitor<R,P> v, ValueOrExpression<E> value, P p)	Apply a visitor to a property value associated with this property definition.
static <E extends Enum<E>> EnumPropertyDefinition.Builder<E>	createBuilder(AbstractManagedObjectDefinition<?,?> d, String propertyName)	Create an enumeration property definition builder.
Class<E>	getEnumClass()	Get the enumeration class used for values of this property.
LocalizableMessage	getValueSynopsis(E value)	Gets the synopsis of the specified enumeration value of this enumeration property definition in the default locale.

Methods inherited from class org.forgerock.opendj.config.PropertyDefinition

compare, compareTo, decodeValue, decodeValueOrExpression, encodeValue, equals, getAdministratorAction, getDefaultBehaviorProvider, getDeprecated, getDescription, getDescription, getManagedObjectDefinition, getName, getSynopsis, getSynopsis, getValueComparator, hashCode, hasOption, initialize, normalizeValue, toString, toString, validateValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Method Detail

createBuilder

public static <E extends Enum<E>> EnumPropertyDefinition.Builder<E> createBuilder(AbstractManagedObjectDefinition<?,?> d,
                                                                                  String propertyName)

Create an enumeration property definition builder.

Type Parameters:

E - The enumeration that should be used for values of this property definition.

Parameters:

d - The managed object definition associated with this property definition.

propertyName - The property name.

Returns:

Returns the new enumeration property definition builder.

accept

public <R,P> R accept(PropertyDefinitionVisitor<R,P> v,
                            P p)

Description copied from class: PropertyDefinition

Apply a visitor to this property definition.

Specified by:

accept in class PropertyDefinition<E extends Enum<E>>

Type Parameters:

R - The return type of the visitor's methods.

P - The type of the additional parameters to the visitor's methods.

Parameters:

v - The property definition visitor.

p - Optional additional visitor parameter.

Returns:

Returns a result as specified by the visitor.

accept

public <R,P> R accept(PropertyValueVisitor<R,P> v,
                            ValueOrExpression<E> value,
                            P p)

Description copied from class: PropertyDefinition

Apply a visitor to a property value associated with this property definition.

Specified by:

accept in class PropertyDefinition<E extends Enum<E>>

Type Parameters:

R - The return type of the visitor's methods.

P - The type of the additional parameters to the visitor's methods.

Parameters:

v - The property value visitor.

value - The property value.

p - Optional additional visitor parameter.

Returns:

Returns a result as specified by the visitor.

getEnumClass

public Class<E> getEnumClass()

Get the enumeration class used for values of this property.

Returns:

Returns the enumeration class used for values of this property.

getValueSynopsis

public LocalizableMessage getValueSynopsis(E value)

Gets the synopsis of the specified enumeration value of this enumeration property definition in the default locale.

Parameters:

value - The enumeration value.

Returns:

Returns the synopsis of the specified enumeration value of this enumeration property definition in the default locale.