Package org.forgerock.opendj.config

Class DNPropertyDefinition

java.lang.Object

org.forgerock.opendj.config.PropertyDefinition<org.forgerock.opendj.ldap.DN>

org.forgerock.opendj.config.DNPropertyDefinition

All Implemented Interfaces:

Comparable<PropertyDefinition<?>>, Comparator<org.forgerock.opendj.ldap.DN>

public final class DNPropertyDefinition
extends PropertyDefinition<org.forgerock.opendj.ldap.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, org.forgerock.opendj.ldap.DN value, P p)	Apply a visitor to a property value associated with this property definition.
int	compare(org.forgerock.opendj.ldap.DN o1, org.forgerock.opendj.ldap.DN o2)	Compares two property values for order.
static DNPropertyDefinition.Builder	createBuilder(AbstractManagedObjectDefinition<?,?> d, String propertyName)	Create a DN property definition builder.
org.forgerock.opendj.ldap.DN	decodeValue(String value)	Parse and validate a string representation of a property value.
org.forgerock.opendj.ldap.DN	getBaseDN()	Get the base DN which all valid values must be immediately subordinate to, or null if there is no based DN.
void	validateValue(org.forgerock.opendj.ldap.DN value)	Determine if the provided property value is valid according to this property definition.

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

castValue, compareTo, encodeValue, 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

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 org.forgerock.opendj.ldap.DN getBaseDN()

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

Returns:

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

validateValue

public void validateValue(org.forgerock.opendj.ldap.DN value)

Description copied from class: PropertyDefinition

Determine if the provided property value is valid according to this property definition.

Specified by:

validateValue in class PropertyDefinition<org.forgerock.opendj.ldap.DN>

Parameters:

value - The property value (must not be null).

decodeValue

public org.forgerock.opendj.ldap.DN decodeValue(String value)

Description copied from class: PropertyDefinition

Parse and validate a string representation of a property value.

Specified by:

decodeValue in class PropertyDefinition<org.forgerock.opendj.ldap.DN>

Parameters:

value - The property string value (must not be null).

Returns:

Returns the decoded property value.

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<org.forgerock.opendj.ldap.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,
                            org.forgerock.opendj.ldap.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<org.forgerock.opendj.ldap.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.

compare

public int compare(org.forgerock.opendj.ldap.DN o1,
                   org.forgerock.opendj.ldap.DN o2)

Description copied from class: PropertyDefinition

Compares two property values for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

This default implementation normalizes both values using PropertyDefinition.normalizeValue(Object) and then performs a case-sensitive string comparison.

Specified by:

compare in interface Comparator<org.forgerock.opendj.ldap.DN>

Overrides:

compare in class PropertyDefinition<org.forgerock.opendj.ldap.DN>

Parameters:

o1 - the first object to be compared.

o2 - the second object to be compared.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.