|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.admin.PropertyDefinition<AttributeType>
org.opends.server.admin.AttributeTypePropertyDefinition
public final class AttributeTypePropertyDefinition
Attribute type property definition.
Nested Class Summary | |
---|---|
static class |
AttributeTypePropertyDefinition.Builder
An interface for incrementally constructing attribute type 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,
AttributeType value,
P p)
Apply a visitor to a property value associated with this property definition. |
|
int |
compare(AttributeType o1,
AttributeType o2)
Compares two property values for order. |
|
static AttributeTypePropertyDefinition.Builder |
createBuilder(AbstractManagedObjectDefinition<?,?> d,
java.lang.String propertyName)
Create a attribute type property definition builder. |
|
AttributeType |
decodeValue(java.lang.String value)
Parse and validate a string representation of a property value. |
|
java.lang.String |
encodeValue(AttributeType value)
Encode the provided property value into its string representation. |
|
static boolean |
isCheckSchema()
Determines whether or not attribute type names should be validated against the schema. |
|
static void |
setCheckSchema(boolean value)
Specify whether or not attribute type names should be validated against the schema. |
|
void |
validateValue(AttributeType 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, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static AttributeTypePropertyDefinition.Builder createBuilder(AbstractManagedObjectDefinition<?,?> d, java.lang.String propertyName)
d
- The managed object definition associated with this
property definition.propertyName
- The property name.
public static boolean isCheckSchema()
true
if attribute type names
should be validated against the schema.public static void setCheckSchema(boolean value)
By default validation is switched on.
value
- true
if attribute type names should be
validated against the schema.public <R,P> R accept(PropertyDefinitionVisitor<R,P> v, P p)
accept
in class PropertyDefinition<AttributeType>
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, AttributeType value, P p)
accept
in class PropertyDefinition<AttributeType>
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 int compare(AttributeType o1, AttributeType 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<AttributeType>
compare
in class PropertyDefinition<AttributeType>
o1
- the first object to be compared.o2
- the second object to be compared.
public AttributeType decodeValue(java.lang.String value) throws IllegalPropertyValueStringException
decodeValue
in class PropertyDefinition<AttributeType>
value
- The property string value (must not be null
).
IllegalPropertyValueStringException
- If the property value string is invalid.public java.lang.String encodeValue(AttributeType value) throws IllegalPropertyValueException
This default implementation simply returns invokes the
Object.toString()
method on the provided value.
encodeValue
in class PropertyDefinition<AttributeType>
value
- The property value (must not be null
).
IllegalPropertyValueException
- If the property value is invalid.public void validateValue(AttributeType value) throws IllegalPropertyValueException
validateValue
in class PropertyDefinition<AttributeType>
value
- The property value (must not be null
).
IllegalPropertyValueException
- If the property value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |