de.lmu.ifi.dbs.elki.utilities.optionhandling
Class FileParameter
java.lang.Object
de.lmu.ifi.dbs.elki.utilities.optionhandling.Option<T>
de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter<File,Object>
de.lmu.ifi.dbs.elki.utilities.optionhandling.FileParameter
public class FileParameter
- extends Parameter<File,Object>
Parameter class for a parameter specifying a file.
- Author:
- Steffi Wanka
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 |
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 |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
fileType
private FileParameter.FileType fileType
- The file type of this file parameter. Specifies if the file is an input of output file.
FileParameter
public FileParameter(OptionID optionID,
FileParameter.FileType fileType)
- Constructs a file parameter with the given optionID, and file type.
- Parameters:
optionID
- optionID the unique id of the optionfileType
- the file type of this file parameter
FileParameter
public FileParameter(OptionID optionID,
FileParameter.FileType fileType,
boolean optional)
- Constructs a file parameter with the given optionID, file type,
and optional flag.
- Parameters:
optionID
- optionID the unique id of the optionfileType
- the file type of this file parameteroptional
- specifies if this parameter is an optional parameter
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<File>
- 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<File>
- 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.
getSyntax
public String getSyntax()
- Returns a string representation of the parameter's type.
- Specified by:
getSyntax
in class Option<File>
- Returns:
- "<file_>"