Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## de.jstacs.algorithms.optimization.termination
Class AbsoluteValueCondition.AbsoluteValueConditionParameterSet

    java.lang.Object
      de.jstacs.parameters.ParameterSet
          de.jstacs.parameters.InstanceParameterSet<AbstractTerminationCondition>
              de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet
                  de.jstacs.algorithms.optimization.termination.AbsoluteValueCondition.AbsoluteValueConditionParameterSet

All Implemented Interfaces:
  GalaxyConvertible, Storable, Cloneable

Enclosing class:
  AbsoluteValueCondition

    public static class AbsoluteValueCondition.AbsoluteValueConditionParameterSet

extends AbstractTerminationCondition.AbstractTerminationConditionParameterSet

This class implements the parameter set for a `AbsoluteValueCondition`.

Author:
  Jens Keilwagen

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`

Constructor Summary
`AbsoluteValueCondition.AbsoluteValueConditionParameterSet()` This constructor creates an empty parameter set.
`AbsoluteValueCondition.AbsoluteValueConditionParameterSet(double absValue)` This constructor creates a filled instance of a parameters set.
`AbsoluteValueCondition.AbsoluteValueConditionParameterSet(StringBuffer xml)` The standard constructor for the interface `Storable`.

Method Summary
`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`.

Methods inherited from class de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet
`clone`

Methods inherited from class de.jstacs.parameters.InstanceParameterSet
`fromXML, getInstance, getInstanceClass, toXML`

Methods inherited from class de.jstacs.parameters.ParameterSet
`fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### AbsoluteValueCondition.AbsoluteValueConditionParameterSet

    public AbsoluteValueCondition.AbsoluteValueConditionParameterSet()
                                                              throws SimpleParameter.DatatypeNotValidException

  This constructor creates an empty parameter set.

  Throws:
    `SimpleParameter.DatatypeNotValidException`

### AbsoluteValueCondition.AbsoluteValueConditionParameterSet

    public AbsoluteValueCondition.AbsoluteValueConditionParameterSet(StringBuffer xml)
                                                              throws NonParsableException

  The standard constructor for the interface `Storable`. Constructs an `AbsoluteValueCondition.AbsoluteValueConditionParameterSet` out of an XML representation.

  Parameters:
    `xml` - the XML representation as `StringBuffer`
  Throws:
    `NonParsableException` - if the `AbsoluteValueCondition.AbsoluteValueConditionParameterSet` could not be reconstructed out of the `StringBuffer` `representation`

### AbsoluteValueCondition.AbsoluteValueConditionParameterSet

    public AbsoluteValueCondition.AbsoluteValueConditionParameterSet(double absValue)
                                                              throws IllegalArgumentException,
                                                                     SimpleParameter.IllegalValueException,
                                                                     SimpleParameter.DatatypeNotValidException

  This constructor creates a filled instance of a parameters set.

  Parameters:
    `absValue` - the number of seconds until stopping the algorithm
  Throws:
    `IllegalArgumentException` - if parameter can not be set
    `SimpleParameter.IllegalValueException` - if parameter can not be set
    `SimpleParameter.DatatypeNotValidException`

Method Detail

### getInstanceComment

    public String getInstanceComment()

  Description copied from class: `InstanceParameterSet`
  Returns a comment (a textual description) of the class that can be constructed using this `ParameterSet`.

  Specified by:
    `getInstanceComment` in class `InstanceParameterSet<AbstractTerminationCondition>`
  Returns:
    the comment of the class

### getInstanceName

    public String getInstanceName()

  Description copied from class: `InstanceParameterSet`
  Returns the name of an instance of the class that can be constructed using this `ParameterSet`.

  Specified by:
    `getInstanceName` in class `InstanceParameterSet<AbstractTerminationCondition>`
  Returns:
    the name of the class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD