org.opends.server.admin

Class ACIPropertyDefinition

java.lang.Object

org.opends.server.admin.PropertyDefinition<Aci>

org.opends.server.admin.ACIPropertyDefinition

All Implemented Interfaces:

Comparable<PropertyDefinition<?>>, Comparator<Aci>

public class ACIPropertyDefinition
extends PropertyDefinition<Aci>

ACI property definition.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opends.server.admin.PropertyDefinition

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

Method Summary

Methods

Modifier and Type	Method and 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, Aci value, P p) Apply a visitor to a property value associated with this property definition.
int	compare(Aci o1, Aci o2) Compares two property values for order.
static ACIPropertyDefinition.Builder	createBuilder(AbstractManagedObjectDefinition<?,?> d, String propertyName) Create a ACI property definition builder.
Aci	decodeValue(String value) Parse and validate a string representation of a property value.
void	validateValue(Aci value) Determine if the provided property value is valid according to this property definition.

Methods inherited from class org.opends.server.admin.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

Method Detail

createBuilder

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

Create a ACI property definition builder.

Parameters:

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

propertyName - The property name.

Returns:

Returns the new ACI property definition builder.

validateValue

public void validateValue(Aci value)
                   throws PropertyException

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

Specified by:

validateValue in class PropertyDefinition<Aci>

Parameters:

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

Throws:

PropertyException - If the property value is invalid.

decodeValue

public Aci decodeValue(String value)
                throws PropertyException

Parse and validate a string representation of a property value.

Specified by:

decodeValue in class PropertyDefinition<Aci>

Parameters:

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

Returns:

Returns the decoded property value.

Throws:

PropertyException - If the property value string is invalid.

accept

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

Apply a visitor to this property definition.

Specified by:

accept in class PropertyDefinition<Aci>

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,
             Aci value,
             P p)

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

Specified by:

accept in class PropertyDefinition<Aci>

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(Aci o1,
          Aci o2)

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<Aci>

Overrides:

compare in class PropertyDefinition<Aci>

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.