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

Class StringParameter

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter<String,String>

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

Direct Known Subclasses:

DynamicParameters.RemainingOptions

public class StringParameter
extends Parameter<String,String>

Parameter class for a parameter specifying a string.

Field Summary

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

constraints, defaultValue, givenValue, optionalParameter, optionid, shortDescription

Constructor Summary

Constructors

Constructor and Description
StringParameter(OptionID optionID) Constructs a string parameter with the given optionID.
StringParameter(OptionID optionID, boolean optional) Constructs a string parameter with the given optionID.
StringParameter(OptionID optionID, List<ParameterConstraint<String>> constraints) Constructs a string parameter with the given optionID, constraints and default value.
StringParameter(OptionID optionID, List<ParameterConstraint<String>> constraints, boolean optional) Constructs a string parameter with the given optionID, constraints and default value.
StringParameter(OptionID optionID, List<ParameterConstraint<String>> constraint, String defaultValue) Constructs a string parameter with the given optionID, constraints and default value.
StringParameter(OptionID optionID, ParameterConstraint<String> constraint) Constructs a string parameter with the given optionID, constraints and default value.
StringParameter(OptionID optionID, ParameterConstraint<String> constraint, boolean optional) Constructs a string parameter with the given optionID, constraints and default value.
StringParameter(OptionID optionID, ParameterConstraint<String> constraint, String defaultValue) Constructs a string parameter with the given optionID, constraints and default value.
StringParameter(OptionID optionID, String defaultValue) Constructs a string parameter with the given optionID, and default value.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSyntax() Returns a string representation of the parameter's type.
String	getValueAsString() Get the value as string.
protected String	parseValue(Object obj) Parse a given value into the destination type.

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

addConstraint, getDefaultValue, getDefaultValueAsString, getFullDescription, getGivenValue, getName, getOptionID, getShortDescription, getValue, getValuesDescription, hasDefaultValue, hasValuesDescription, isDefined, isOptional, isValid, setDefaultValue, setOptional, setShortDescription, setValue, setValueInternal, tookDefaultValue, tryDefaultValue, useDefaultValue, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParameter

public StringParameter(OptionID optionID,
               List<ParameterConstraint<String>> constraint,
               String defaultValue)

Constructs a string parameter with the given optionID, constraints and default value.

Parameters:

optionID - the unique id of the parameter

constraint - parameter constraint

defaultValue - the default value of the parameter

StringParameter

public StringParameter(OptionID optionID,
               List<ParameterConstraint<String>> constraints,
               boolean optional)

Constructs a string parameter with the given optionID, constraints and default value.

Parameters:

optionID - the unique id of the parameter

constraints - parameter constraint

optional - Flag to signal an optional parameter.

StringParameter

public StringParameter(OptionID optionID,
               List<ParameterConstraint<String>> constraints)

Constructs a string parameter with the given optionID, constraints and default value.

Parameters:

optionID - the unique id of the parameter

constraints - parameter constraint

StringParameter

public StringParameter(OptionID optionID,
               ParameterConstraint<String> constraint,
               String defaultValue)

Constructs a string parameter with the given optionID, constraints and default value.

Parameters:

optionID - the unique id of the parameter

constraint - parameter constraint

defaultValue - the default value of the parameter

StringParameter

public StringParameter(OptionID optionID,
               ParameterConstraint<String> constraint,
               boolean optional)

Constructs a string parameter with the given optionID, constraints and default value.

Parameters:

optionID - the unique id of the parameter

constraint - parameter constraint

optional - Flag to signal an optional parameter.

StringParameter

public StringParameter(OptionID optionID,
               ParameterConstraint<String> constraint)

Constructs a string parameter with the given optionID, constraints and default value.

Parameters:

optionID - the unique id of the parameter

constraint - parameter constraint

StringParameter

public StringParameter(OptionID optionID,
               String defaultValue)

Constructs a string parameter with the given optionID, and default value.

Parameters:

optionID - the unique id of the parameter

defaultValue - the default value of the parameter

StringParameter

public StringParameter(OptionID optionID,
               boolean optional)

Constructs a string parameter with the given optionID.

Parameters:

optionID - the unique id of the parameter

optional - Flag to signal an optional parameter.

StringParameter

public StringParameter(OptionID optionID)

Constructs a string parameter with the given optionID.

Parameters:

optionID - the unique id of the parameter

Method Detail

getValueAsString

public String getValueAsString()

Get the value as string. May return null

Specified by:

getValueAsString in class Parameter<String,String>

Returns:

Value as string

parseValue

protected String parseValue(Object obj)
                     throws ParameterException

Parse a given value into the destination type.

Specified by:

parseValue in class Parameter<String,String>

Parameters:

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

Returns:

Parsed object

Throws:

ParameterException - when the object cannot be parsed.

getSyntax

public String getSyntax()

Returns a string representation of the parameter's type.

Specified by:

getSyntax in class Parameter<String,String>

Returns:

"<string>"