Package org.forgerock.opendj.setup.model

Class Profile.DomainParameter

java.lang.Object

org.forgerock.opendj.setup.model.Profile.Parameter<Profile.DomainParameter,Dn>

org.forgerock.opendj.setup.model.Profile.DomainParameter

Enclosing class:

Profile

public final class Profile.DomainParameter
extends Profile.Parameter<Profile.DomainParameter,Dn>

Represents a parameter whose value is a domain automatically converted into a DN object.

Method Summary

Modifier and Type	Method	Description
<R, P, E extends Exception> R	accept(Profile.ParameterVisitor<R,P,E> visitor, P p)	Applies a Profile.ParameterVisitor to this Profile.Parameter.
Profile.DomainParameter	expressionAllowed()	Specifies that common configuration expressions can be specified for this profile parameter.
Dn	parseStringValue(String strValue)	Parses provided string value into this parameter type and returns the typed value.

Methods inherited from class org.forgerock.opendj.setup.model.Profile.Parameter

advanced, defaultValue, defaultValue, defaultValueCanBeDerivedAtSetup, defaultValueFromSetupTool, description, descriptionIfNoValueSet, equals, getAddAnotherValueMsg, getDefaultValue, getDescriptionIfNoValueSetMsg, getDescriptionMsg, getHelpMsg, getOptionalPromptMsg, getPromptForValueMsg, getSyntax, getSyntaxWithoutExpression, getValue, getValueOrExpression, getVariableName, hashCode, help, isAdvanced, isMultivalued, isOptional, multivalued, multivalued, optional, optional, prompt, property, toString

Methods inherited from class java.lang.Object

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

Method Details

parseStringValue

public Dn parseStringValue(String strValue)
                    throws com.forgerock.opendj.cli.ArgumentException

Description copied from class: Profile.Parameter

Parses provided string value into this parameter type and returns the typed value.

Specified by:

parseStringValue in class Profile.Parameter<Profile.DomainParameter,Dn>

Parameters:

strValue - A string representing the parameter value to be parsed

Returns:

The typed value associated to provided string

Throws:

com.forgerock.opendj.cli.ArgumentException - If an error occurred while parsing provided string value

expressionAllowed

public Profile.DomainParameter expressionAllowed()

Description copied from class: Profile.Parameter

Specifies that common configuration expressions can be specified for this profile parameter.

Overrides:

expressionAllowed in class Profile.Parameter<Profile.DomainParameter,Dn>

Returns:

This profile parameter

accept

public <R,
P,
E extends Exception> R accept(Profile.ParameterVisitor<R,P,E> visitor,
 P p)
                                   throws E

Description copied from class: Profile.Parameter

Applies a Profile.ParameterVisitor to this Profile.Parameter.

Specified by:

accept in class Profile.Parameter<Profile.DomainParameter,Dn>

Type Parameters:

R - The return type of the visitor's methods

P - The type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter

E - The type of the exception thrown by the visitor method if it fails, or NeverThrowsException if the visitor cannot fail

Parameters:

visitor - The parameter visitor

p - Optional additional visitor parameter

Returns:

A result as specified by the visitor

Throws:

E - If the visitor failed