|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.jstacs.parameters.ParameterSet
de.jstacs.parameters.SimpleParameterSet
public class SimpleParameterSet
Class for a ParameterSet
that is constructed from an array of Parameters
and thus does nothing in the loadParameters()
-method.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet |
---|
ParameterSet.ParameterList |
Field Summary |
---|
Fields inherited from class de.jstacs.parameters.ParameterSet |
---|
alternativeInstanceClass, errorMessage, parameters, parent, ranged |
Constructor Summary | |
---|---|
SimpleParameterSet(Parameter[] parameters)
Creates a new SimpleParameterSet from an array of Parameter s. |
|
SimpleParameterSet(StringBuffer representation)
Constructs a SimpleParameterSet from its XML-representation |
Method Summary | |
---|---|
SimpleParameterSet |
clone()
Creates a full clone (deep copy) of this ParameterSet . |
String |
getInstanceComment()
Returns a comment (a textual description) of the class that can be constructed using this ParameterSet . |
String |
getInstanceName()
Returns the name of an instance of the class that can be constructed using this ParameterSet . |
protected void |
loadParameters()
Loads the parameters for this ParameterSet . |
void |
reset()
Resets all parameters in this ParameterSet to their
default values or null if not default value was provided. |
Methods inherited from class de.jstacs.parameters.ParameterSet |
---|
fromXML, getErrorMessage, getId, getInstance, getInstanceClass, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, resetToFirst, setAlternativeInstanceClass, setParent, simplify, toXML, valuesToString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SimpleParameterSet(Parameter[] parameters)
SimpleParameterSet
from an array of Parameter
s.
parameters
- the parameterspublic SimpleParameterSet(StringBuffer representation) throws NonParsableException
SimpleParameterSet
from its XML-representation
representation
- the XML-representation
NonParsableException
- a NonParsableException
is thrown if representation
could not be parsedMethod Detail |
---|
public SimpleParameterSet clone() throws CloneNotSupportedException
ParameterSet
ParameterSet
. As
a convenience-method the user can use
fillWithStandardFieldsForClone(ParameterSet)
on a newly
created instance of a subclass of ParameterSet
to obtain a
clone/copy of all standard member variables (those already defined in
ParameterSet
) in the passed ParameterSet
.
Using this method, the cloning-process becomes merely three-step:ParameterSet
,
most likely with an empty constructor or the one taking just the
instance-class
this.fillWithStandardFieldsForClone
on this
instance
Object
's method clone()
clone
in class ParameterSet
ParameterSet
CloneNotSupportedException
public void reset()
ParameterSet
ParameterSet
to their
default values or null
if not default value was provided.
reset
in class ParameterSet
Parameter.reset()
protected void loadParameters()
ParameterSet
ParameterSet
. This is in
most cases done by simply creating a new ArrayList<Parameter>
for the
field parameters/code>
and filling it with instances of subclasses of Parameter
- Specified by:
loadParameters
in class ParameterSet
- See Also:
ParameterSet.parameters
,
Parameter
public String getInstanceName()
ParameterSet
ParameterSet
.
getInstanceName
in class ParameterSet
public String getInstanceComment()
ParameterSet
ParameterSet
.
getInstanceComment
in class ParameterSet
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |