Package com.github.javacliparser
Interface Option
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractClassOption
,AbstractClassOption
,AbstractOption
,ClassOption
,ClassOption
,ClassOptionWithListenerOption
,ClassOptionWithNames
,EditableMultiChoiceOption
,FileOption
,FlagOption
,FloatOption
,IntOption
,ListOption
,MultiChoiceOption
,RangeOption
,StringOption
,WEKAClassOption
public interface Option extends Serializable
Interface representing an option or parameter.- Version:
- $Revision: 7 $
- Author:
- Richard Kirkby (rkirkby@cs.waikato.ac.nz)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Option
copy()
Gets a copy of this optionchar
getCLIChar()
Gets the Command Line Interface text of this optionString
getDefaultCLIString()
Gets the Command Line Interface textString
getName()
Gets the name of this optionString
getPurpose()
Gets the purpose of this optionString
getStateString()
Gets the state of this option in human readable formString
getValueAsCLIString()
Gets the value of a Command Line Interface text as a stringvoid
resetToDefault()
Resets this option to the default valuevoid
setValueViaCLIString(String s)
Sets value of this option via the Command Line Interface text
-
-
-
Method Detail
-
getName
String getName()
Gets the name of this option- Returns:
- the name of this option
-
getCLIChar
char getCLIChar()
Gets the Command Line Interface text of this option- Returns:
- the Command Line Interface text
-
getPurpose
String getPurpose()
Gets the purpose of this option- Returns:
- the purpose of this option
-
getDefaultCLIString
String getDefaultCLIString()
Gets the Command Line Interface text- Returns:
- the Command Line Interface text
-
setValueViaCLIString
void setValueViaCLIString(String s)
Sets value of this option via the Command Line Interface text- Parameters:
s
- the Command Line Interface text
-
getValueAsCLIString
String getValueAsCLIString()
Gets the value of a Command Line Interface text as a string- Returns:
- the string with the value of the Command Line Interface text
-
resetToDefault
void resetToDefault()
Resets this option to the default value
-
getStateString
String getStateString()
Gets the state of this option in human readable form- Returns:
- the string with state of this option in human readable form
-
copy
Option copy()
Gets a copy of this option- Returns:
- the copy of this option
-
-