de.lmu.ifi.dbs.elki.utilities.optionhandling
Class IntListParameter
java.lang.Object
de.lmu.ifi.dbs.elki.utilities.optionhandling.Option<T>
de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter<List<T>,List<T>>
de.lmu.ifi.dbs.elki.utilities.optionhandling.ListParameter<Integer>
de.lmu.ifi.dbs.elki.utilities.optionhandling.IntListParameter
public class IntListParameter
- extends ListParameter<Integer>
Paramter class for a parameter specifying a list of integer values.
- Author:
- Elke Achtert
Method Summary |
String |
getSyntax()
Returns a string representation of the parameter's type. |
boolean |
isValid(String value)
Checks if the given argument is valid for this option. |
void |
setDefaultValue(int allListDefaultValue)
Sets the default value of this parameter. |
void |
setValue(String value)
Sets the value of the option. |
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter |
addConstraint, addConstraintList, getDefaultValue, getFullDescription, getValue, getValuesDescription, hasDefaultValue, hasValuesDescription, isOptional, isSet, reset, setDefaultValue, setDefaultValueToValue, setOptional, tookDefaultValue |
IntListParameter
public IntListParameter(OptionID optionID,
ParameterConstraint<List<Integer>> constraint,
boolean optional,
List<Integer> defaultValue)
- Constructs an integer list parameter
- Parameters:
optionID
- constraint
- optional
- defaultValue
-
IntListParameter
public IntListParameter(OptionID optionID,
ParameterConstraint<List<Integer>> constraint)
- Constructs an integer list parameter
- Parameters:
optionID
- constraint
-
IntListParameter
public IntListParameter(OptionID optionID)
- Constructs an integer list parameter
- Parameters:
optionID
-
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<List<Integer>>
- Parameters:
value
- the option's value to be set
- Throws:
ParameterException
- if the given value is not a valid value for this option.
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<List<Integer>>
- 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.
setDefaultValue
public void setDefaultValue(int allListDefaultValue)
- Sets the default value of this parameter.
- Parameters:
allListDefaultValue
- default value for all list elements of this
parameter
getSyntax
public String getSyntax()
- Returns a string representation of the parameter's type.
- Specified by:
getSyntax
in class Option<List<Integer>>
- Returns:
- "<int_1,...,int_n>"