Package org.forgerock.opendj.config

Class IntegerPropertyDefinition

java.lang.Object

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

org.forgerock.opendj.config.IntegerPropertyDefinition

All Implemented Interfaces:

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

public final class IntegerPropertyDefinition
extends PropertyDefinition<Integer>

Integer property definition.

All values must be zero or positive and within the lower/upper limit constraints. Support is provided for "unlimited" values. These are represented using a negative value or using the string "unlimited".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IntegerPropertyDefinition.Builder	An interface for incrementally constructing integer 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<Integer> value, P p)	Apply a visitor to a property value associated with this property definition.
static IntegerPropertyDefinition.Builder	createBuilder(AbstractManagedObjectDefinition<?,?> d, String propertyName)	Create an integer property definition builder.
int	getLowerLimit()	Get the lower limit.
LocalizableMessage	getUnitSynopsis()	Gets the optional unit synopsis of this integer property definition in the default locale.
LocalizableMessage	getUnitSynopsis(Locale locale)	Gets the optional unit synopsis of this integer property definition in the specified locale.
Integer	getUpperLimit()	Get the upper limit.
boolean	isAllowUnlimited()	Determine whether this property allows unlimited values.
void	toString(StringBuilder builder)	Append a string representation of the property definition to the provided string builder.

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, 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 IntegerPropertyDefinition.Builder createBuilder(AbstractManagedObjectDefinition<?,?> d,
                                                              String propertyName)

Create an integer property definition builder.

Parameters:

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

propertyName - The property name.

Returns:

Returns the new integer property definition builder.

getLowerLimit

public int getLowerLimit()

Get the lower limit.

Returns:

Returns the lower limit.

getUpperLimit

public Integer getUpperLimit()

Get the upper limit.

Returns:

Returns the upper limit or null if there is no upper limit.

getUnitSynopsis

public LocalizableMessage getUnitSynopsis()

Gets the optional unit synopsis of this integer property definition in the default locale.

Returns:

the unit synopsis of this integer property definition in the default locale, or null if there is no unit synopsis.

getUnitSynopsis

public LocalizableMessage getUnitSynopsis(Locale locale)

Gets the optional unit synopsis of this integer property definition in the specified locale.

Parameters:

locale - The locale.

Returns:

the unit synopsis of this integer property definition in the specified locale, or null if there is no unit synopsis.

isAllowUnlimited

public boolean isAllowUnlimited()

Determine whether this property allows unlimited values.

Returns:

Returns true if this this property allows unlimited values.

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<Integer>

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<Integer> 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<Integer>

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.

toString

public void toString(StringBuilder builder)

Description copied from class: PropertyDefinition

Append a string representation of the property definition to the provided string builder.

This simple implementation just outputs the propertyName of the property definition. Sub-classes should override this method to provide more complete string representations.

Overrides:

toString in class PropertyDefinition<Integer>

Parameters:

builder - The string builder where the string representation should be appended.