|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.jstacs.parameters.ParameterSet
de.jstacs.parameters.InstanceParameterSet
public abstract class InstanceParameterSet
Container class for a set of Parameter
s that can be used to
instantiate another class.
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 |
---|
errorMessage, parameters, parent, ranged |
Constructor Summary | |
---|---|
InstanceParameterSet(Class instanceClass)
Constructs an InstanceParameterSet from the class that can be
instantiated using this InstanceParameterSet . |
|
InstanceParameterSet(StringBuffer representation)
The standard constructor for the interface Storable . |
Method Summary | |
---|---|
protected void |
fromXML(StringBuffer representation)
Parses the instance fields of a ParameterSet from the XML
representation as returned by ParameterSet.toXML() . |
InstantiableFromParameterSet |
getInstance()
Returns a new instance of the class of getInstanceClass() that
was created using this ParameterSet . |
Class |
getInstanceClass()
Returns the class of the instances that can be constructed using this set. |
abstract String |
getInstanceComment()
Returns a comment (a textual description) of the class that can be constructed using this ParameterSet . |
abstract String |
getInstanceName()
Returns the name of an instance of the class that can be constructed using this ParameterSet . |
StringBuffer |
toXML()
This method returns an XML representation as StringBuffer of an
instance of the implementing class. |
Methods inherited from class de.jstacs.parameters.ParameterSet |
---|
clone, fromGalaxy, getErrorMessage, getId, getIndex, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, loadParameters, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, reset, resetToFirst, setParent, simplify, toGalaxy, valuesToString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public InstanceParameterSet(Class instanceClass) throws IllegalArgumentException
InstanceParameterSet
from the class that can be
instantiated using this InstanceParameterSet
. The set of
parameters is loaded by the ParameterSet.loadParameters()
-method
if this InstanceParameterSet
is expected to be filled with
values.
instanceClass
- the class to be instantiated
IllegalArgumentException
- if instanceClass
is nullpublic InstanceParameterSet(StringBuffer representation) throws NonParsableException
Storable
.
Constructs an InstanceParameterSet
out of an XML representation.
representation
- the XML representation as StringBuffer
NonParsableException
- if the InstanceParameterSet
could not be
reconstructed out of the StringBuffer
representation
Method Detail |
---|
public Class getInstanceClass()
public InstantiableFromParameterSet getInstance() throws ParameterSetParser.NotInstantiableException
getInstanceClass()
that
was created using this ParameterSet
.
ParameterSetParser.NotInstantiableException
- if the class could not be instantiatedParameterSetParser
public abstract String getInstanceComment()
ParameterSet
.
public abstract String getInstanceName()
ParameterSet
.
public StringBuffer toXML()
Storable
StringBuffer
of an
instance of the implementing class.
toXML
in interface Storable
toXML
in class ParameterSet
protected void fromXML(StringBuffer representation) throws NonParsableException
ParameterSet
ParameterSet
from the XML
representation as returned by ParameterSet.toXML()
.
fromXML
in class ParameterSet
representation
- the XML representation as StringBuffer
NonParsableException
- if the XML code could not be parsedParameterSet.toXML()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |