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

Class NumberParameter<THIS extends NumberParameter<THIS,T>,T extends Number>

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter<THIS,T>

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

Type Parameters:

THIS - type self-reference

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

All Implemented Interfaces:

Parameter<T>

Direct Known Subclasses:

DoubleParameter, IntParameter, LongParameter

public abstract class NumberParameter<THIS extends NumberParameter<THIS,T>,T extends Number>
extends AbstractParameter<THIS,T>

Abstract class for defining a number parameter.

Since:

0.2

Author:

Steffi Wanka, Erich Schubert

Field Summary

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

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, 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.AbstractParameter

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,
               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