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

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.Option<T>
          de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter<String,String>
              de.lmu.ifi.dbs.elki.utilities.optionhandling.StringParameter

All Implemented Interfaces:

Loggable

public class StringParameter
extends Parameter<String,String>

Parameter class for a parameter specifying a string value.

Author:

Steffi Wanka

Field Summary

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

constraints, defaultValue, optionalParameter

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

name, shortDescription, value

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug

Constructor Summary

StringParameter(String name, String description)
Deprecated.

StringParameter(String name, String description, List<ParameterConstraint<String>> cons)
Deprecated.

StringParameter(String name, String description, ParameterConstraint<String> con)
Deprecated.

Method Summary

protected String	getParameterType() Returns a string representation of the parameter's type.
boolean	isValid(String value) Checks if the given argument is valid for this option.
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, getDescription, getValue, hasDefaultValue, isOptional, isSet, reset, setDefaultValue, setDefaultValueToValue, setOptional, tookDefaultValue

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

getName, getShortDescription, setShortDescription

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParameter

@Deprecated
public StringParameter(String name,
                                  String description)

Deprecated.

Constructs a string parameter with the given name and description

Parameters:

name - the parameter name

description - the parameter description

StringParameter

@Deprecated
public StringParameter(String name,
                                  String description,
                                  ParameterConstraint<String> con)

Deprecated.

Constructs a string parameter with the given name, description, and a parameter constraint.

Parameters:

name - the parameter name

description - the parameter description

con - a parameter constraint for this string parameter

StringParameter

@Deprecated
public StringParameter(String name,
                                  String description,
                                  List<ParameterConstraint<String>> cons)

Deprecated.

Constructs a string parameter with the given name, description, and a list of parameter constraints.

Parameters:

name - the parameter name

description - the parameter description

cons - a list of parameter constraints for this string parameter

Method Detail

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<String>

Parameters:

value - the option's value to be set

Throws:

ParameterException - if the given value is not a valid value for this option.

See Also:

Option.setValue(java.lang.String)

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<String>

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.

See Also:

Option.isValid(java.lang.String)

getParameterType

protected String getParameterType()

Returns a string representation of the parameter's type.

Specified by:

getParameterType in class Parameter<String,String>

Returns:

"<string>"

See Also:

Parameter.getParameterType()