|
|||||||||
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.String>
org.opends.server.admin.StringPropertyDefinition
public final class StringPropertyDefinition
String property definition.
Nested Class Summary | |
---|---|
static class |
StringPropertyDefinition.Builder
An interface for incrementally constructing string 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.String value,
P p)
Apply a visitor to a property value associated with this property definition. |
|
static StringPropertyDefinition.Builder |
createBuilder(AbstractManagedObjectDefinition<?,?> d,
java.lang.String propertyName)
Create a string property definition builder. |
|
java.lang.String |
decodeValue(java.lang.String value)
Parse and validate a string representation of a property value. |
|
java.util.regex.Pattern |
getPattern()
Gets the optional regular expression pattern which values of this property must match. |
|
Message |
getPatternSynopsis()
Gets the pattern synopsis of this string property definition in the default locale. |
|
Message |
getPatternSynopsis(java.util.Locale locale)
Gets the optional pattern synopsis of this string property definition in the specified locale. |
|
java.lang.String |
getPatternUsage()
Gets a user-friendly usage string representing the pattern which can be used in error messages and help (e.g. |
|
boolean |
isCaseInsensitive()
Query whether values of this property are case-insensitive. |
|
java.lang.String |
normalizeValue(java.lang.String value)
Get a normalized string representation of a property value. |
|
void |
validateValue(java.lang.String value)
Determine if the provided property value is valid according to this property definition. |
Methods inherited from class org.opends.server.admin.PropertyDefinition |
---|
castValue, compare, compareTo, encodeValue, equals, getAdministratorAction, getDefaultBehaviorProvider, getDescription, getDescription, getManagedObjectDefinition, getName, getSynopsis, getSynopsis, hashCode, hasOption, initialize, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static StringPropertyDefinition.Builder createBuilder(AbstractManagedObjectDefinition<?,?> d, java.lang.String propertyName)
d
- The managed object definition associated with this
property definition.propertyName
- The property name.
public <R,P> R accept(PropertyDefinitionVisitor<R,P> v, P p)
accept
in class PropertyDefinition<java.lang.String>
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.String value, P p)
accept
in class PropertyDefinition<java.lang.String>
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 java.lang.String decodeValue(java.lang.String value) throws IllegalPropertyValueStringException
decodeValue
in class PropertyDefinition<java.lang.String>
value
- The property string value (must not be null
).
IllegalPropertyValueStringException
- If the property value string is invalid.public java.util.regex.Pattern getPattern()
null
if there is no pattern.public Message getPatternSynopsis()
null
if there is no pattern synopsis (which is the case when
there is no pattern matching defined for this string
property definition).public Message getPatternSynopsis(java.util.Locale locale)
locale
- The locale.
null
if there is no pattern synopsis (which is the case when
there is no pattern matching defined for this string
property definition).public java.lang.String getPatternUsage()
null
if there is no pattern.public boolean isCaseInsensitive()
true
if values are
case-insensitive, or false
otherwise.public java.lang.String normalizeValue(java.lang.String value) throws IllegalPropertyValueException
This method may throw an exception if the provided value is
invalid. However, applications should not assume that
implementations of this method will always validate a value. This
task is the responsibility of PropertyDefinition.validateValue(Object)
.
This default implementation simply returns the string representation of the provided value. Sub-classes might want to override this method if this behavior is insufficient (for example, a string property definition might strip white-space and convert characters to lower-case).
normalizeValue
in class PropertyDefinition<java.lang.String>
value
- The property value to be normalized.
IllegalPropertyValueException
- If the property value is invalid.public void validateValue(java.lang.String value) throws IllegalPropertyValueException
validateValue
in class PropertyDefinition<java.lang.String>
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 |