Package elki.utilities.optionhandling.parameters

Class IntGeneratorParameter

java.lang.Object

elki.utilities.optionhandling.parameters.AbstractParameter<IntGeneratorParameter,IntGenerator>

elki.utilities.optionhandling.parameters.IntGeneratorParameter

All Implemented Interfaces:

Parameter<IntGenerator>

public class IntGeneratorParameter
extends AbstractParameter<IntGeneratorParameter,IntGenerator>

Parameter class for a parameter specifying ranges of integer values.

Since:

0.7.5

Author:

Erich Schubert

Field Summary

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

constraints, defaultValue, givenValue, optionalParameter, optionid

Constructor Summary

Constructors

Constructor	Description
IntGeneratorParameter(OptionID optionID)	Constructs an integer list parameter

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefaultValueAsString()	Get the default value as string.
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.Consumer<IntGenerator> consumer)	Get the parameter.
protected IntGenerator	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, 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

IntGeneratorParameter

public IntGeneratorParameter(OptionID optionID)

Constructs an integer list parameter

Parameters:

optionID - the unique id of this parameter

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

getDefaultValueAsString

public java.lang.String getDefaultValueAsString()

Description copied from interface: Parameter

Get the default value as string.

Specified by:

getDefaultValueAsString in interface Parameter<IntGenerator>

Overrides:

getDefaultValueAsString in class AbstractParameter<IntGeneratorParameter,IntGenerator>

Returns:

default value

parseValue

protected IntGenerator 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<IntGeneratorParameter,IntGenerator>

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.

For a full documentation, see ParseIntRanges.

Returns:

"<start,+=increment,end,...,start,*=factor,end,int1,int2>"

grab

public boolean grab(Parameterization config,
                    java.util.function.Consumer<IntGenerator> consumer)

Get the parameter.

Parameters:

config - Parameterization

consumer - Output consumer

Returns:

true if valid