de.lmu.ifi.dbs.elki.utilities.optionhandling
Class NumberParameter<T extends Number>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.Option<T>
          de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter<T,Number>
              de.lmu.ifi.dbs.elki.utilities.optionhandling.NumberParameter<T>

Type Parameters:

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

All Implemented Interfaces:

Loggable

Direct Known Subclasses:

DoubleParameter, IntParameter, LongParameter

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

Abstract class for defining a number parameter.

Author:

Steffi Wanka

Field Summary

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

constraints, defaultValue, optionalParameter

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

name, shortDescription, value

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug

Constructor Summary

NumberParameter(OptionID optionID)
Constructs a number parameter with the given optionID.

NumberParameter(String name, String description)
Deprecated.

Method Summary

T	getNumberValue() Returns the number value of the parameter.

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

addConstraint, addConstraintList, getDefaultValue, getDescription, getParameterType, getValue, hasDefaultValue, isOptional, isSet, reset, setDefaultValue, setDefaultValueToValue, setOptional, tookDefaultValue

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

getName, getShortDescription, isValid, setShortDescription, setValue

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning

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)

Constructs a number parameter with the given optionID.

Parameters:

optionID - the unique id of the option

NumberParameter

@Deprecated
public NumberParameter(String name,
                                  String description)

Deprecated.

Constructs a number parameter with the given name and description.

Parameters:

name - the parameter name

description - the parameter description

Method Detail

getNumberValue

public T getNumberValue()

Returns the number value of the parameter.

Returns:

number value of the parameter.