|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.admin.PropertyDefinition.AbstractBuilder<java.lang.Long,DurationPropertyDefinition>
org.opends.server.admin.DurationPropertyDefinition.Builder
public static class DurationPropertyDefinition.Builder
An interface for incrementally constructing duration property definitions.
Method Summary | |
---|---|
protected DurationPropertyDefinition |
buildInstance(AbstractManagedObjectDefinition<?,?> d,
java.lang.String propertyName,
java.util.EnumSet<PropertyOption> options,
AdministratorAction adminAction,
DefaultBehaviorProvider<java.lang.Long> defaultBehavior)
Build a property definition based on the properties of this builder. |
void |
setAllowUnlimited(boolean allowUnlimited)
Specify whether or not this property definition will allow unlimited values (default is false). |
void |
setBaseUnit(DurationUnit unit)
Set the base unit for this property definition (values including limits are specified in this unit). |
void |
setBaseUnit(java.lang.String unit)
Set the base unit for this property definition (values including limits are specified in this unit). |
void |
setLowerLimit(long lowerLimit)
Set the lower limit in milli-seconds. |
void |
setLowerLimit(java.lang.String lowerLimit)
Set the lower limit using a string representation of the limit. |
void |
setMaximumUnit(DurationUnit unit)
Set the maximum unit for this property definition. |
void |
setMaximumUnit(java.lang.String unit)
Set the maximum unit for this property definition. |
void |
setUpperLimit(java.lang.Long upperLimit)
Set the upper limit in milli-seconds. |
void |
setUpperLimit(java.lang.String upperLimit)
Set the upper limit using a string representation of the limit. |
Methods inherited from class org.opends.server.admin.PropertyDefinition.AbstractBuilder |
---|
getInstance, setAdministratorAction, setDefaultBehaviorProvider, setOption |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public final void setBaseUnit(java.lang.String unit) throws java.lang.IllegalArgumentException
unit
- The string representation of the base unit (must not
be null
).
java.lang.IllegalArgumentException
- If the provided unit name did not correspond to a
known duration unit, or if the base unit is bigger
than the maximum unit.public final void setBaseUnit(DurationUnit unit) throws java.lang.IllegalArgumentException
unit
- The base unit (must not be null
).
java.lang.IllegalArgumentException
- If the provided base unit is bigger than the maximum
unit.public final void setMaximumUnit(java.lang.String unit) throws java.lang.IllegalArgumentException
unit
- The string representation of the maximum unit, or
null
if there should not be a maximum
unit.
java.lang.IllegalArgumentException
- If the provided unit name did not correspond to a
known duration unit, or if the maximum unit is
smaller than the base unit.public final void setMaximumUnit(DurationUnit unit) throws java.lang.IllegalArgumentException
unit
- The maximum unit, or null
if there
should not be a maximum unit.
java.lang.IllegalArgumentException
- If the provided maximum unit is smaller than the base
unit.public final void setLowerLimit(long lowerLimit) throws java.lang.IllegalArgumentException
lowerLimit
- The new lower limit (must be >= 0) in milli-seconds.
java.lang.IllegalArgumentException
- If a negative lower limit was specified, or the lower
limit is greater than the upper limit.public final void setLowerLimit(java.lang.String lowerLimit) throws java.lang.IllegalArgumentException
lowerLimit
- The string representation of the new lower limit.
java.lang.IllegalArgumentException
- If the lower limit could not be parsed, or if a
negative lower limit was specified, or the lower
limit is greater than the upper limit.public final void setUpperLimit(java.lang.Long upperLimit) throws java.lang.IllegalArgumentException
upperLimit
- The new upper limit in milli-seconds, or
null
if there is no upper limit.
java.lang.IllegalArgumentException
- If a negative upper limit was specified, or the lower
limit is greater than the upper limit or unlimited
durations are permitted.public final void setUpperLimit(java.lang.String upperLimit) throws java.lang.IllegalArgumentException
upperLimit
- The string representation of the new upper limit, or
null
if there is no upper limit.
java.lang.IllegalArgumentException
- If the upper limit could not be parsed, or if the
lower limit is greater than the upper limit.public final void setAllowUnlimited(boolean allowUnlimited) throws java.lang.IllegalArgumentException
allowUnlimited
- true
if the property will allow
unlimited values, or false
otherwise.
java.lang.IllegalArgumentException
- If unlimited values are to be permitted but there is
an upper limit specified.protected DurationPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?,?> d, java.lang.String propertyName, java.util.EnumSet<PropertyOption> options, AdministratorAction adminAction, DefaultBehaviorProvider<java.lang.Long> defaultBehavior)
buildInstance
in class PropertyDefinition.AbstractBuilder<java.lang.Long,DurationPropertyDefinition>
d
- The managed object definition associated with this
property definition.propertyName
- The property name.options
- Options applicable to this definition.adminAction
- The administrator action.defaultBehavior
- The default behavior provider.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |