Package org.forgerock.opendj.config

Class DnPropertyDefinition

java.lang.Object

org.forgerock.opendj.config.PropertyDefinition<Dn>

org.forgerock.opendj.config.DnPropertyDefinition

All Implemented Interfaces:

Comparable<PropertyDefinition<?>>, Comparator<ValueOrExpression<Dn>>

public final class DnPropertyDefinition
extends PropertyDefinition<Dn>

DN property definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DnPropertyDefinition.Builder	An interface for incrementally constructing DN property definitions.

Nested classes/interfaces inherited from class org.forgerock.opendj.config.PropertyDefinition

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

Method Summary

Modifier and Type	Method	Description
<R,P> R	accept(PropertyDefinitionVisitor<R,P> v, P p)	Apply a visitor to this property definition.
<R,P> R	accept(PropertyValueVisitor<R,P> v, ValueOrExpression<Dn> value, P p)	Apply a visitor to a property value associated with this property definition.
static DnPropertyDefinition.Builder	createBuilder(AbstractManagedObjectDefinition<?,?> d, String propertyName)	Create a DN property definition builder.
Dn	getBaseDn()	Get the base DN which all valid values must be immediately subordinate to, or null if there is no based DN.

Methods inherited from class org.forgerock.opendj.config.PropertyDefinition

compare, compareTo, decodeValue, decodeValueOrExpression, encodeValue, equals, getAdministratorAction, getDefaultBehaviorProvider, getDescription, getDescription, getManagedObjectDefinition, getName, getSynopsis, getSynopsis, getValueComparator, hashCode, hasOption, initialize, normalizeValue, toString, toString, validateValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Method Detail

createBuilder

public static DnPropertyDefinition.Builder createBuilder(AbstractManagedObjectDefinition<?,?> d,
                                                         String propertyName)

Create a DN property definition builder.

Parameters:

d - The managed object definition associated with this property definition.

propertyName - The property name.

Returns:

Returns the new boolean property definition builder.

getBaseDn

public Dn getBaseDn()

Get the base DN which all valid values must be immediately subordinate to, or null if there is no based DN.

Returns:

the base DN which all valid values must be immediately subordinate to.

accept

public <R,P> R accept(PropertyDefinitionVisitor<R,P> v,
                            P p)

Description copied from class: PropertyDefinition

Apply a visitor to this property definition.

Specified by:

accept in class PropertyDefinition<Dn>

Type Parameters:

R - The return type of the visitor's methods.

P - The type of the additional parameters to the visitor's methods.

Parameters:

v - The property definition visitor.

p - Optional additional visitor parameter.

Returns:

Returns a result as specified by the visitor.

accept

public <R,P> R accept(PropertyValueVisitor<R,P> v,
                            ValueOrExpression<Dn> value,
                            P p)

Description copied from class: PropertyDefinition

Apply a visitor to a property value associated with this property definition.

Specified by:

accept in class PropertyDefinition<Dn>

Type Parameters:

R - The return type of the visitor's methods.

P - The type of the additional parameters to the visitor's methods.

Parameters:

v - The property value visitor.

value - The property value.

p - Optional additional visitor parameter.

Returns:

Returns a result as specified by the visitor.