org.opends.server.admin

Class StringPropertyDefinition.Builder

java.lang.Object

org.opends.server.admin.PropertyDefinition.AbstractBuilder<String,StringPropertyDefinition>

org.opends.server.admin.StringPropertyDefinition.Builder

Enclosing class:

StringPropertyDefinition

public static class StringPropertyDefinition.Builder
extends PropertyDefinition.AbstractBuilder<String,StringPropertyDefinition>

An interface for incrementally constructing string property definitions.

Method Summary

Methods

Modifier and Type	Method and Description
protected StringPropertyDefinition	buildInstance(AbstractManagedObjectDefinition<?,?> d, String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction, DefaultBehaviorProvider<String> defaultBehavior) Build a property definition based on the properties of this builder.
void	setCaseInsensitive(boolean value) Set a flag indicating whether values of this property are case-insensitive.
void	setPattern(String pattern, String patternUsage) Set the regular expression pattern which values of this property must match.

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

setCaseInsensitive

public final void setCaseInsensitive(boolean value)

Set a flag indicating whether values of this property are case-insensitive.

Parameters:

value - true if values are case-insensitive, or false otherwise.

setPattern

public final void setPattern(String pattern,
              String patternUsage)
                      throws PatternSyntaxException

Set the regular expression pattern which values of this property must match. By default there is no pattern defined.

Parameters:

pattern - The regular expression pattern string, or null if there is no pattern.

patternUsage - A user-friendly usage string representing the pattern which can be used in error messages and help (e.g. for patterns which match a host/port combination, the usage string "HOST:PORT" would be appropriate).

Throws:

PatternSyntaxException - If the provided regular expression pattern has an invalid syntax.

buildInstance

protected StringPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?,?> d,
                                     String propertyName,
                                     EnumSet<PropertyOption> options,
                                     AdministratorAction adminAction,
                                     DefaultBehaviorProvider<String> defaultBehavior)

Build a property definition based on the properties of this builder.

Specified by:

buildInstance in class PropertyDefinition.AbstractBuilder<String,StringPropertyDefinition>

Parameters:

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.

Returns:

The new property definition.