de.lmu.ifi.dbs.elki.utilities.optionhandling
Class LongParameter

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<Long>
                  de.lmu.ifi.dbs.elki.utilities.optionhandling.LongParameter

All Implemented Interfaces:

Loggable

public class LongParameter
extends NumberParameter<Long>

Parameter class for a parameter specifying a long value.

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

LongParameter(OptionID optionID)
Constructs a long parameter with the given optionID.

LongParameter(OptionID optionID, List<ParameterConstraint<Number>> cons)
Constructs a long parameter with the given optionID, and parameter constraints.

LongParameter(OptionID optionID, ParameterConstraint<Number> cons)
Constructs a long parameter with the given optionID, and parameter constraint.

LongParameter(String name, String description)
Deprecated.

LongParameter(String name, String description, List<ParameterConstraint<Number>> cons)
Deprecated.

LongParameter(String name, String description, ParameterConstraint<Number> cons)
Deprecated.

Method Summary

protected String	getParameterType() Returns a string representation of the parameter's type.
boolean	isValid(String value) Checks if the given argument is valid for this option.
void	setValue(String value) Sets the value of the option.

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

getNumberValue

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

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

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

getName, getShortDescription, setShortDescription

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

LongParameter

public LongParameter(OptionID optionID)

Constructs a long parameter with the given optionID.

Parameters:

optionID - the unique OptionID for this parameter

LongParameter

public LongParameter(OptionID optionID,
                     ParameterConstraint<Number> cons)

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

Parameters:

optionID - the unique OptionID for this parameter

cons - the parameter constraint for this long parameter

LongParameter

public LongParameter(OptionID optionID,
                     List<ParameterConstraint<Number>> cons)

Constructs a long parameter with the given optionID, and parameter constraints.

Parameters:

optionID - the unique OptionID for this parameter

cons - a list of parameter constraints for this long parameter

LongParameter

@Deprecated
public LongParameter(String name,
                                String description)

Deprecated.

Constructs a long parameter with the given name and description.

Parameters:

name - the parameter name

description - the parameter description

LongParameter

@Deprecated
public LongParameter(String name,
                                String description,
                                ParameterConstraint<Number> cons)

Deprecated.

Constructs a long parameter with the given name, description, and parameter constraint.

Parameters:

name - the parameter name

description - the parameter description

cons - the parameter constraint for this long parameter

LongParameter

@Deprecated
public LongParameter(String name,
                                String description,
                                List<ParameterConstraint<Number>> cons)

Deprecated.

Constructs a long parameter with the given name, description, and a list of parameter constraints.

Parameters:

name - the parameter name

description - the parameter description

cons - a list of parameter constraints for this long parameter

Method Detail

isValid

public boolean isValid(String value)
                throws ParameterException

Description copied from class: Option

Checks if the given argument is valid for this option.

Specified by:

isValid in class Option<Long>

Parameters:

value - option value to be checked

Returns:

true, if the given value is valid for this option

Throws:

ParameterException - if the given value is not a valid value for this option.

See Also:

Option.isValid(java.lang.String)

setValue

public void setValue(String value)
              throws ParameterException

Description copied from class: Option

Sets the value of the option.

Specified by:

setValue in class Option<Long>

Parameters:

value - the option's value to be set

Throws:

ParameterException - if the given value is not a valid value for this option.

See Also:

Option.setValue(java.lang.String)

getParameterType

protected String getParameterType()

Returns a string representation of the parameter's type.

Specified by:

getParameterType in class Parameter<Long,Number>

Returns:

"<long>"

See Also:

Parameter.getParameterType()