Package de.gebit.integrity.fixtures

Class ArbitraryParameterEnumerator.ArbitraryParameterDefinition

java.lang.Object

de.gebit.integrity.fixtures.ArbitraryParameterEnumerator.ArbitraryParameterDefinition

Enclosing interface:

ArbitraryParameterEnumerator

public static class ArbitraryParameterEnumerator.ArbitraryParameterDefinition
extends Object

A container for the definition of one arbitrary parameter.

Author:

Rene Schneider - initial API and implementation

Constructor Summary

Constructors

Constructor	Description
ArbitraryParameterDefinition(String aName, String aDescription)	Creates a new instance.
ArbitraryParameterDefinition(String aName, String aDescription, ArbitraryParameterEnumerator.ArbitraryParameterSuffix aSuffix, boolean anIsNestedObjectParamFlag)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addSubdefinition(ArbitraryParameterEnumerator.ArbitraryParameterDefinition aSubdefinition)	Adds a subdefinition.
String	getDescription()
String	getName()
ArbitraryParameterEnumerator.ArbitraryParameterDefinition	getSubdefinitionByName(String aName)	Searches a subdefinition by name.
ArbitraryParameterEnumerator.ArbitraryParameterDefinition	getSubdefinitionByPath(List<String> aPath)	Resolves a path of subdefinitions starting with the current definition (which must be the root of the path!).
List<ArbitraryParameterEnumerator.ArbitraryParameterDefinition>	getSubdefinitions()
ArbitraryParameterEnumerator.ArbitraryParameterSuffix	getSuffix()
boolean	hasSubdefinitions()	Checks whether this definition has any subdefinitions.
boolean	isNestedObjectParam()
void	setDescription(String aDescription)
void	setName(String aName)
void	setNestedObjectParam(boolean aNestedObjectParam)
void	setSuffix(ArbitraryParameterEnumerator.ArbitraryParameterSuffix aSuffix)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArbitraryParameterDefinition

public ArbitraryParameterDefinition(String aName,
                                    String aDescription)

Creates a new instance.

Parameters:

aName - The parameter name

aDescription - The description for content assist

ArbitraryParameterDefinition

public ArbitraryParameterDefinition(String aName,
                                    String aDescription,
                                    ArbitraryParameterEnumerator.ArbitraryParameterSuffix aSuffix,
                                    boolean anIsNestedObjectParamFlag)

Creates a new instance.

Parameters:

aName - The parameter name

aDescription - The description for content assist

aSuffix - What to add after the parameter.

anIsNestedObjectParamFlag - Whether this is a parameter that will contain a nested object.

Method Detail

getName

public String getName()

getDescription

public String getDescription()

getSuffix

public ArbitraryParameterEnumerator.ArbitraryParameterSuffix getSuffix()

isNestedObjectParam

public boolean isNestedObjectParam()

setName

public void setName(String aName)

setDescription

public void setDescription(String aDescription)

setSuffix

public void setSuffix(ArbitraryParameterEnumerator.ArbitraryParameterSuffix aSuffix)

setNestedObjectParam

public void setNestedObjectParam(boolean aNestedObjectParam)

addSubdefinition

public void addSubdefinition(ArbitraryParameterEnumerator.ArbitraryParameterDefinition aSubdefinition)

Adds a subdefinition.

Parameters:

aSubdefinition - the subdefinition to add

getSubdefinitions

public List<ArbitraryParameterEnumerator.ArbitraryParameterDefinition> getSubdefinitions()

hasSubdefinitions

public boolean hasSubdefinitions()

Checks whether this definition has any subdefinitions.

Returns:

true if subdefinitions are present

getSubdefinitionByName

public ArbitraryParameterEnumerator.ArbitraryParameterDefinition getSubdefinitionByName(String aName)

Searches a subdefinition by name.

Parameters:

aName - the name to search for

Returns:

the subdefinition or null if not found

getSubdefinitionByPath

public ArbitraryParameterEnumerator.ArbitraryParameterDefinition getSubdefinitionByPath(List<String> aPath)

Resolves a path of subdefinitions starting with the current definition (which must be the root of the path!).

Parameters:

aPath - the path to follow

Returns:

the subdefinition at the end of the path, or null if none was found