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 java.lang.Object
A container for the definition of one arbitrary parameter.- Author:
- Rene Schneider - initial API and implementation
-
-
Constructor Summary
Constructors Constructor Description ArbitraryParameterDefinition(java.lang.String aName, java.lang.String aDescription)
Creates a new instance.ArbitraryParameterDefinition(java.lang.String aName, java.lang.String aDescription, ArbitraryParameterEnumerator.ArbitraryParameterSuffix aSuffix, boolean anIsNestedObjectParamFlag)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSubdefinition(ArbitraryParameterEnumerator.ArbitraryParameterDefinition aSubdefinition)
Adds a subdefinition.java.lang.String
getDescription()
java.lang.String
getName()
ArbitraryParameterEnumerator.ArbitraryParameterDefinition
getSubdefinitionByName(java.lang.String aName)
Searches a subdefinition by name.ArbitraryParameterEnumerator.ArbitraryParameterDefinition
getSubdefinitionByPath(java.util.List<java.lang.String> aPath)
Resolves a path of subdefinitions starting with the current definition (which must be the root of the path!).java.util.List<ArbitraryParameterEnumerator.ArbitraryParameterDefinition>
getSubdefinitions()
ArbitraryParameterEnumerator.ArbitraryParameterSuffix
getSuffix()
boolean
hasSubdefinitions()
Checks whether this definition has any subdefinitions.boolean
isNestedObjectParam()
void
setDescription(java.lang.String aDescription)
void
setName(java.lang.String aName)
void
setNestedObjectParam(boolean aNestedObjectParam)
void
setSuffix(ArbitraryParameterEnumerator.ArbitraryParameterSuffix aSuffix)
-
-
-
Constructor Detail
-
ArbitraryParameterDefinition
public ArbitraryParameterDefinition(java.lang.String aName, java.lang.String aDescription)
Creates a new instance.- Parameters:
aName
- The parameter nameaDescription
- The description for content assist
-
ArbitraryParameterDefinition
public ArbitraryParameterDefinition(java.lang.String aName, java.lang.String aDescription, ArbitraryParameterEnumerator.ArbitraryParameterSuffix aSuffix, boolean anIsNestedObjectParamFlag)
Creates a new instance.- Parameters:
aName
- The parameter nameaDescription
- The description for content assistaSuffix
- What to add after the parameter.anIsNestedObjectParamFlag
- Whether this is a parameter that will contain a nested object.
-
-
Method Detail
-
getName
public java.lang.String getName()
-
getDescription
public java.lang.String getDescription()
-
getSuffix
public ArbitraryParameterEnumerator.ArbitraryParameterSuffix getSuffix()
-
isNestedObjectParam
public boolean isNestedObjectParam()
-
setName
public void setName(java.lang.String aName)
-
setDescription
public void setDescription(java.lang.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 java.util.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(java.lang.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(java.util.List<java.lang.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
-
-