Package org.forgerock.opendj.config

Class PropertyDefinition.AbstractBuilder<T,D extends PropertyDefinition<T>>

java.lang.Object
org.forgerock.opendj.config.PropertyDefinition.AbstractBuilder<T,D>
Type Parameters:
T - The data-type of values of the property.
D - The type of property definition constructed by this builder.
Direct Known Subclasses:
AciPropertyDefinition.Builder, AggregationPropertyDefinition.Builder, AttributeTypePropertyDefinition.Builder, BooleanPropertyDefinition.Builder, ClassPropertyDefinition.Builder, DnPropertyDefinition.Builder, DurationPropertyDefinition.Builder, EnumPropertyDefinition.Builder, HostPortPropertyDefinition.Builder, HostPropertyDefinition.Builder, IntegerPropertyDefinition.Builder, IpAddressMaskPropertyDefinition.Builder, SizePropertyDefinition.Builder, StringPropertyDefinition.Builder
Enclosing class:
PropertyDefinition<T>
protected abstract static class PropertyDefinition.AbstractBuilder<T,D extends PropertyDefinition<T>> extends Object
An interface for incrementally constructing property definitions.

  • Constructor Details

    • AbstractBuilder

      protected AbstractBuilder(AbstractManagedObjectDefinition<?,?> d, String propertyName)
      Create a property definition builder.
      Parameters:
      d - The managed object definition associated with this property definition.
      propertyName - The property name.

  • Method Details

    • getInstance

      public final D getInstance()
      Construct a property definition based on the properties of this builder.
      Returns:
      The new property definition.

    • setAdministratorAction

      public final void setAdministratorAction(AdministratorAction adminAction)
      Set the administrator action.
      Parameters:
      adminAction - The administrator action.

    • setDefaultBehaviorProvider

      public final void setDefaultBehaviorProvider(DefaultBehaviorProvider<ValueOrExpression<T>> defaultBehavior)
      Set the default behavior provider.
      Parameters:
      defaultBehavior - The default behavior provider.

    • setOption

      public final void setOption(PropertyOption option)
      Add a property definition option.
      Parameters:
      option - The property option.

    • setDeprecated

      public final void setDeprecated(Deprecated deprecated)
      Register a deprecation with this property definition.

      This method must not be called by applications.

      Parameters:
      deprecated - The deprecated to be registered.

    • buildInstance

      protected abstract D buildInstance(AbstractManagedObjectDefinition<?,?> d, String propertyName, EnumSet<PropertyOption> options, AdministratorAction adminAction, DefaultBehaviorProvider<ValueOrExpression<T>> defaultBehavior, Deprecated deprecated)
      Build a property definition based on the properties of this builder.
      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.
      deprecated - The deprecation description.
      Returns:
      The new property definition.