de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters

Class NumberParameter<T extends Number>

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter<Number,T>

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.NumberParameter<T>

Type Parameters:

T - the type of a possible value (i.e., the type of the option)

Direct Known Subclasses:

DoubleParameter, IntParameter, LongParameter

public abstract class NumberParameter<T extends Number>
extends Parameter<Number,T>

Abstract class for defining a number parameter.

Field Summary

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter

constraints, defaultValue, givenValue, optionalParameter, optionid, shortDescription

Constructor Summary

Constructors

Constructor and Description
NumberParameter(OptionID optionID) Constructs a number parameter with the given optionID.
NumberParameter(OptionID optionID, boolean optional) Constructs a number parameter with the given optionID and optional flag.
NumberParameter(OptionID optionID, List<ParameterConstraint<Number>> constraints) Constructs a number parameter with the given optionID, and constraint.
NumberParameter(OptionID optionID, List<ParameterConstraint<Number>> constraints, boolean optional) Constructs a number parameter with the given optionID, constraint, and optional flag.
NumberParameter(OptionID optionID, List<ParameterConstraint<Number>> constraints, T defaultValue) Constructs a number parameter with the given optionID, constraint, and optional flag.
NumberParameter(OptionID optionID, ParameterConstraint<Number> constraint) Constructs a number parameter with the given optionID, and constraint.
NumberParameter(OptionID optionID, ParameterConstraint<Number> constraint, boolean optional) Constructs a number parameter with the given optionID, constraint, and optional flag.
NumberParameter(OptionID optionID, ParameterConstraint<Number> constraint, T defaultValue) Constructs a number parameter with the given optionID, constraint, and optional flag.
NumberParameter(OptionID optionID, T defaultValue) Constructs a number parameter with the given optionID and default Value.

Method Summary

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter

addConstraint, getDefaultValue, getDefaultValueAsString, getFullDescription, getGivenValue, getName, getOptionID, getShortDescription, getSyntax, getValue, getValueAsString, getValuesDescription, hasDefaultValue, hasValuesDescription, isDefined, isOptional, isValid, parseValue, setDefaultValue, setOptional, setShortDescription, setValue, setValueInternal, tookDefaultValue, tryDefaultValue, useDefaultValue, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberParameter

public NumberParameter(OptionID optionID,
               List<ParameterConstraint<Number>> constraints,
               T defaultValue)

Constructs a number parameter with the given optionID, constraint, and optional flag.

Parameters:

optionID - the unique id of this parameter

constraints - the constraints of this parameter

defaultValue - the default value for this parameter

NumberParameter

public NumberParameter(OptionID optionID,
               List<ParameterConstraint<Number>> constraints,
               boolean optional)

Constructs a number parameter with the given optionID, constraint, and optional flag.

Parameters:

optionID - the unique id of this parameter

constraints - the constraint of this parameter

optional - specifies if this parameter is an optional parameter

NumberParameter

public NumberParameter(OptionID optionID,
               List<ParameterConstraint<Number>> constraints)

Constructs a number parameter with the given optionID, and constraint.

Parameters:

optionID - the unique id of this parameter

constraints - the constraints of this parameter, may be empty if there are no constraints

NumberParameter

public NumberParameter(OptionID optionID,
               ParameterConstraint<Number> constraint,
               T defaultValue)

Constructs a number parameter with the given optionID, constraint, and optional flag.

Parameters:

optionID - the unique id of this parameter

constraint - the constraint of this parameter

defaultValue - the default value for this parameter

NumberParameter

public NumberParameter(OptionID optionID,
               ParameterConstraint<Number> constraint,
               boolean optional)

Constructs a number parameter with the given optionID, constraint, and optional flag.

Parameters:

optionID - the unique id of this parameter

constraint - the constraint of this parameter

optional - specifies if this parameter is an optional parameter

NumberParameter

public NumberParameter(OptionID optionID,
               ParameterConstraint<Number> constraint)

Constructs a number parameter with the given optionID, and constraint.

Parameters:

optionID - the unique id of this parameter

constraint - the constraint of this parameter

NumberParameter

public NumberParameter(OptionID optionID,
               T defaultValue)

Constructs a number parameter with the given optionID and default Value.

Parameters:

optionID - the unique id of this parameter

defaultValue - the default value for this parameter

NumberParameter

public NumberParameter(OptionID optionID,
               boolean optional)

Constructs a number parameter with the given optionID and optional flag.

Parameters:

optionID - the unique id of this parameter

optional - specifies if this parameter is an optional parameter

NumberParameter

public NumberParameter(OptionID optionID)

Constructs a number parameter with the given optionID.

Parameters:

optionID - the unique id of this parameter