Package org.forgerock.opendj.config

Class PathPropertyDefinition

java.lang.Object

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

org.forgerock.opendj.config.PathPropertyDefinition

All Implemented Interfaces:

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

public final class PathPropertyDefinition
extends PropertyDefinition<Path>

Property definition associated to a path syntax.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PathPropertyDefinition.Builder	An interface for incrementally constructing PathPropertyDefinition.

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, boolean isServer)	Apply a visitor to this property definition.
<R, P> R	accept(PropertyValueVisitor<R,P> v, ValueOrExpression<Path> value, P p, boolean isServer)	Apply a visitor to a property value associated with this property definition.
static PathPropertyDefinition.Builder	createBuilder(AbstractManagedObjectDefinition<?,?> definition, String propertyName)	Create a Host:Port definition builder.
String	getUsageSynopsis()	Returns a user-friendly usage synopsis for this property.
boolean	isDirectory()	Query whether values of this property represent a directory or a file.

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

compare, compareTo, decodeValue, decodeValueOrExpression, encodeValue, equals, getAdministratorAction, getDefaultBehaviorProvider, getDeprecated, getDescription, getDescription, getManagedObjectDefinition, getName, getSynopsis, getSynopsis, getValueComparator, hashCode, hasOption, initialize, normalizeValue, toString, toString, validateMandatoryValuesArePresent, validateNoValuesIfVirtual, validateSingleValuedConstraint, 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 Details

createBuilder

public static PathPropertyDefinition.Builder createBuilder(AbstractManagedObjectDefinition<?,?> definition,
 String propertyName)

Create a Host:Port definition builder.

Parameters:

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

propertyName - The property name.

Returns:

Returns a new Host:Port definition builder.

isDirectory

public boolean isDirectory()

Query whether values of this property represent a directory or a file.

Returns:

Returns true if values represent a directory, or false if values represent a file.

getUsageSynopsis

public String getUsageSynopsis()

Returns a user-friendly usage synopsis for this property.

Returns:

a user-friendly usage synopsis for this property

accept

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

Description copied from class: PropertyDefinition

Apply a visitor to this property definition.

Specified by:

accept in class PropertyDefinition<Path>

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.

isServer - If schema should be strictly checked in a server environment

Returns:

Returns a result as specified by the visitor.

accept

public <R,
P> R accept(PropertyValueVisitor<R,P> v,
 ValueOrExpression<Path> value,
 P p,
 boolean isServer)

Description copied from class: PropertyDefinition

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

Specified by:

accept in class PropertyDefinition<Path>

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.

isServer - If schema should be strictly checked in a server environment

Returns:

Returns a result as specified by the visitor.