|
|||||||||
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.Long>
org.opends.server.admin.DurationPropertyDefinition
public final class DurationPropertyDefinition
Duration property definition.
A duration property definition comprises of:
long
values in
the base unit defined for the duration property definition.
Nested Class Summary | |
---|---|
static class |
DurationPropertyDefinition.Builder
An interface for incrementally constructing duration 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.Long value,
P p)
Apply a visitor to a property value associated with this property definition. |
|
int |
compare(java.lang.Long o1,
java.lang.Long o2)
Compares two property values for order. |
|
static DurationPropertyDefinition.Builder |
createBuilder(AbstractManagedObjectDefinition<?,?> d,
java.lang.String propertyName)
Create a duration property definition builder. |
|
java.lang.Long |
decodeValue(java.lang.String value)
Parse and validate a string representation of a property value. |
|
java.lang.String |
encodeValue(java.lang.Long value)
Encode the provided property value into its string representation. |
|
DurationUnit |
getBaseUnit()
Get the base unit for this property definition (values including limits are specified in this unit). |
|
long |
getLowerLimit()
Get the lower limit in milli-seconds. |
|
DurationUnit |
getMaximumUnit()
Get the maximum unit for this property definition if specified. |
|
java.lang.Long |
getUpperLimit()
Get the upper limit in milli-seconds. |
|
boolean |
isAllowUnlimited()
Determine whether this property allows unlimited durations. |
|
void |
toString(java.lang.StringBuilder builder)
Append a string representation of the property definition to the provided string builder. |
|
void |
validateValue(java.lang.Long 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 DurationPropertyDefinition.Builder createBuilder(AbstractManagedObjectDefinition<?,?> d, java.lang.String propertyName)
d
- The managed object definition associated with this
property definition.propertyName
- The property name.
public DurationUnit getBaseUnit()
public DurationUnit getMaximumUnit()
null
if there is no maximum unit.public long getLowerLimit()
public java.lang.Long getUpperLimit()
null
if there is no upper limit.public boolean isAllowUnlimited()
true
if this this property allows
unlimited durations.public void validateValue(java.lang.Long value) throws IllegalPropertyValueException
validateValue
in class PropertyDefinition<java.lang.Long>
value
- The property value (must not be null
).
IllegalPropertyValueException
- If the property value is invalid.public java.lang.String encodeValue(java.lang.Long value) throws IllegalPropertyValueException
This default implementation simply returns invokes the
Object.toString()
method on the provided value.
encodeValue
in class PropertyDefinition<java.lang.Long>
value
- The property value (must not be null
).
IllegalPropertyValueException
- If the property value is invalid.public java.lang.Long decodeValue(java.lang.String value) throws IllegalPropertyValueStringException
decodeValue
in class PropertyDefinition<java.lang.Long>
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.Long>
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.Long value, P p)
accept
in class PropertyDefinition<java.lang.Long>
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.Long>
builder
- The string builder where the string representation
should be appended.public int compare(java.lang.Long o1, java.lang.Long 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.Long>
compare
in class PropertyDefinition<java.lang.Long>
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 |