|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.admin.PropertyDefinition<java.lang.Integer>
org.opends.server.admin.IntegerPropertyDefinition
public final class IntegerPropertyDefinition
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 | |
---|---|
static class |
IntegerPropertyDefinition.Builder
An interface for incrementally constructing integer 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,
java.lang.Integer value,
P p)
Apply a visitor to a property value associated with this property definition. |
|
int |
compare(java.lang.Integer o1,
java.lang.Integer o2)
Compares two property values for order. |
|
static IntegerPropertyDefinition.Builder |
createBuilder(AbstractManagedObjectDefinition<?,?> d,
java.lang.String propertyName)
Create an integer property definition builder. |
|
java.lang.Integer |
decodeValue(java.lang.String value)
Parse and validate a string representation of a property value. |
|
java.lang.String |
encodeValue(java.lang.Integer value)
Encode the provided property value into its string representation. |
|
int |
getLowerLimit()
Get the lower limit. |
|
Message |
getUnitSynopsis()
Gets the optional unit synopsis of this integer property definition in the default locale. |
|
Message |
getUnitSynopsis(java.util.Locale locale)
Gets the optional unit synopsis of this integer property definition in the specified locale. |
|
java.lang.Integer |
getUpperLimit()
Get the upper limit. |
|
boolean |
isAllowUnlimited()
Determine whether this property allows unlimited values. |
|
void |
toString(java.lang.StringBuilder builder)
Append a string representation of the property definition to the provided string builder. |
|
void |
validateValue(java.lang.Integer value)
Determine if the provided property value is valid according to this property definition. |
Methods inherited from class org.opends.server.admin.PropertyDefinition |
---|
castValue, compareTo, equals, getAdministratorAction, getDefaultBehaviorProvider, getDescription, getDescription, getManagedObjectDefinition, getName, getSynopsis, getSynopsis, hashCode, hasOption, initialize, normalizeValue, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static IntegerPropertyDefinition.Builder createBuilder(AbstractManagedObjectDefinition<?,?> d, java.lang.String propertyName)
d
- The managed object definition associated with this
property definition.propertyName
- The property name.
public int getLowerLimit()
public java.lang.Integer getUpperLimit()
null
if there is no upper
limit.public Message getUnitSynopsis()
null
if there is no unit synopsis.public Message getUnitSynopsis(java.util.Locale locale)
locale
- The locale.
null
if there is no unit synopsis.public boolean isAllowUnlimited()
true
if this this property allows unlimited
values.public void validateValue(java.lang.Integer value) throws IllegalPropertyValueException
validateValue
in class PropertyDefinition<java.lang.Integer>
value
- The property value (must not be null
).
IllegalPropertyValueException
- If the property value is invalid.public java.lang.String encodeValue(java.lang.Integer value) throws IllegalPropertyValueException
This default implementation simply returns invokes the
Object.toString()
method on the provided value.
encodeValue
in class PropertyDefinition<java.lang.Integer>
value
- The property value (must not be null
).
IllegalPropertyValueException
- If the property value is invalid.public java.lang.Integer decodeValue(java.lang.String value) throws IllegalPropertyValueStringException
decodeValue
in class PropertyDefinition<java.lang.Integer>
value
- The property string value (must not be null
).
IllegalPropertyValueStringException
- If the property value string is invalid.public <R,P> R accept(PropertyDefinitionVisitor<R,P> v, P p)
accept
in class PropertyDefinition<java.lang.Integer>
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, java.lang.Integer value, P p)
accept
in class PropertyDefinition<java.lang.Integer>
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 void toString(java.lang.StringBuilder builder)
This simple implementation just outputs the propertyName of the property definition. Sub-classes should override this method to provide more complete string representations.
toString
in class PropertyDefinition<java.lang.Integer>
builder
- The string builder where the string representation
should be appended.public int compare(java.lang.Integer o1, java.lang.Integer o2)
This default implementation normalizes both values using
PropertyDefinition.normalizeValue(Object)
and then performs a
case-sensitive string comparison.
compare
in interface java.util.Comparator<java.lang.Integer>
compare
in class PropertyDefinition<java.lang.Integer>
o1
- the first object to be compared.o2
- the second object to be compared.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |