Package elki.utilities.optionhandling.parameters

Class IntParameter

java.lang.Object

elki.utilities.optionhandling.parameters.AbstractParameter<P,T>

elki.utilities.optionhandling.parameters.NumberParameter<IntParameter,java.lang.Integer>

elki.utilities.optionhandling.parameters.IntParameter

All Implemented Interfaces:

Parameter<java.lang.Integer>

public class IntParameter
extends NumberParameter<IntParameter,java.lang.Integer>

Parameter class for a parameter specifying an integer value.

Since:

0.1

Author:

Steffi Wanka, Erich Schubert

Field Summary

Fields inherited from class elki.utilities.optionhandling.parameters.AbstractParameter

constraints, defaultValue, givenValue, optionalParameter, optionid

Constructor Summary

Constructors

Constructor	Description
IntParameter(OptionID optionID)	Constructs an integer parameter with the given optionID.
IntParameter(OptionID optionID, int defaultValue)	Constructs an integer parameter with the given optionID.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getSyntax()	Returns a string representation of the parameter's type.
java.lang.String	getValueAsString()	Get the value as string.
boolean	grab(Parameterization config, java.util.function.IntConsumer consumer)	Get the parameter.
int	intValue()	Get the parameter value as integer
protected java.lang.Integer	parseValue(java.lang.Object obj)	Parse a given value into the destination type.

Methods inherited from class elki.utilities.optionhandling.parameters.AbstractParameter

addConstraint, describeValues, getConstraints, getDefaultValue, getDefaultValueAsString, getOptionID, getValue, hasDefaultValue, isDefined, isOptional, isValid, setDefaultValue, setOptional, setValue, setValueInternal, tookDefaultValue, tryDefaultValue, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

IntParameter

public IntParameter(OptionID optionID,
                    int defaultValue)

Constructs an integer parameter with the given optionID.

Parameters:

optionID - optionID the unique id of the option

defaultValue - the default value

IntParameter

public IntParameter(OptionID optionID)

Constructs an integer parameter with the given optionID.

Parameters:

optionID - optionID the unique id of the option

Method Detail

getValueAsString

public java.lang.String getValueAsString()

Description copied from interface: Parameter

Get the value as string. May return null

Returns:

Value as string

parseValue

protected java.lang.Integer parseValue(java.lang.Object obj)
                                throws ParameterException

Description copied from class: AbstractParameter

Parse a given value into the destination type.

Specified by:

parseValue in class AbstractParameter<IntParameter,java.lang.Integer>

Parameters:

obj - Object to parse (may be a string representation!)

Returns:

Parsed object

Throws:

ParameterException - when the object cannot be parsed.

getSyntax

public java.lang.String getSyntax()

Returns a string representation of the parameter's type.

Returns:

"<int>"

intValue

public int intValue()

Get the parameter value as integer

Returns:

Parameter value

grab

public boolean grab(Parameterization config,
                    java.util.function.IntConsumer consumer)

Get the parameter.

Parameters:

config - Parameterization

consumer - Output consumer

Returns:

true if valid