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

Class IntListParameter

java.lang.Object

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

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ListParameter<IntListParameter,int[]>

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

All Implemented Interfaces:

Parameter<int[]>

public class IntListParameter
extends ListParameter<IntListParameter,int[]>

Parameter class for a parameter specifying a list of integer values.

Since:

0.1

Author:

Elke Achtert, Erich Schubert

Field Summary

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

LIST_SEP, SPLIT, VECTOR_SEP, VECTOR_SPLIT

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
IntListParameter(OptionID optionID) Constructs an integer list parameter
IntListParameter(OptionID optionID, boolean optional) Constructs an integer list parameter

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultValueAsString() Get the default value as string.
java.lang.String	getSyntax() Returns a string representation of the parameter's type.
long[]	getValueAsBitSet() Get the values as a bitmask.
java.lang.String	getValueAsString() Get the value as string.
protected int[]	parseValue(java.lang.Object obj) Parse a given value into the destination type.
int	size() Size of the list.

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

addConstraint, describeValues, getConstraints, getDefaultValue, getOptionID, getShortDescription, getValue, hasDefaultValue, isDefined, isOptional, isValid, setDefaultValue, setOptional, setShortDescription, 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

IntListParameter

public IntListParameter(OptionID optionID,
                        boolean optional)

Constructs an integer list parameter

Parameters:

optionID - the unique id of this parameter

optional - specifies if this parameter is an optional parameter

IntListParameter

public IntListParameter(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

Specified by:

getValueAsString in interface Parameter<int[]>

Specified by:

getValueAsString in class AbstractParameter<IntListParameter,int[]>

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<int[]>

Overrides:

getDefaultValueAsString in class AbstractParameter<IntListParameter,int[]>

Returns:

default value

parseValue

protected int[] 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<IntListParameter,int[]>

Parameters:

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

Returns:

Parsed object

Throws:

ParameterException - when the object cannot be parsed.

size

public int size()

Description copied from class: ListParameter

Size of the list.

Specified by:

size in class ListParameter<IntListParameter,int[]>

Returns:

Size

getSyntax

public java.lang.String getSyntax()

Returns a string representation of the parameter's type.

Specified by:

getSyntax in interface Parameter<int[]>

Specified by:

getSyntax in class AbstractParameter<IntListParameter,int[]>

Returns:

"<int_1,...,int_n>"

getValueAsBitSet

public long[] getValueAsBitSet()

Get the values as a bitmask. See also: BitsUtil

Returns:

Bitmask