org.opends.server.admin

Class OptionalRelationDefinition<C extends ConfigurationClient,S extends Configuration>

java.lang.Object

org.opends.server.admin.RelationDefinition<C,S>

org.opends.server.admin.OptionalRelationDefinition<C,S>

Type Parameters:

C - The type of client managed object configuration that this relation definition refers to.

S - The type of server managed object configuration that this relation definition refers to.

public final class OptionalRelationDefinition<C extends ConfigurationClient,S extends Configuration>
extends RelationDefinition<C,S>

A managed object composite relationship definition which represents a composition of an optional single managed object (i.e. the referenced managed object may or may not be present).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptionalRelationDefinition.Builder<C extends ConfigurationClient,S extends Configuration> An interface for incrementally constructing optional relation definitions.

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

RelationDefinition.AbstractBuilder<C extends ConfigurationClient,S extends Configuration,D extends RelationDefinition<C,S>>, RelationDefinition.Common<C extends ConfigurationClient,S extends Configuration>

Method Summary

Methods

Modifier and Type	Method and Description
<R,P> R	accept(RelationDefinitionVisitor<R,P> v, P p) Apply a visitor to this relation definition.
DefaultManagedObject<? extends C,? extends S>	getDefaultManagedObject() Gets the optional default managed object associated with this optional relation definition.
protected void	initialize() Performs any run-time initialization required by this relation definition.
void	toString(StringBuilder builder) Append a string representation of the managed object relation to the provided string builder.

Methods inherited from class org.opends.server.admin.RelationDefinition

getChildDefinition, getDescription, getDescription, getName, getParentDefinition, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, hasOption, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

accept

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

Apply a visitor to this relation definition.

Specified by:

accept in class RelationDefinition<C extends ConfigurationClient,S extends Configuration>

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 relation definition visitor.

p - Optional additional visitor parameter.

Returns:

Returns a result as specified by the visitor.

getDefaultManagedObject

public DefaultManagedObject<? extends C,? extends S> getDefaultManagedObject()

Gets the optional default managed object associated with this optional relation definition.

Returns:

Returns the default managed object or null if there is no default managed object defined for this relation definition.

toString

public void toString(StringBuilder builder)

Append a string representation of the managed object relation to the provided string builder.

Specified by:

toString in class RelationDefinition<C extends ConfigurationClient,S extends Configuration>

Parameters:

builder - The string builder where the string representation should be appended.

initialize

protected void initialize()
                   throws Exception

Performs any run-time initialization required by this relation definition. This may include resolving managed object paths and property names.

Overrides:

initialize in class RelationDefinition<C extends ConfigurationClient,S extends Configuration>

Throws:

Exception - If this relation definition could not be initialized.