Package com.github.javacliparser

Interface Option

All Superinterfaces:

java.io.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 java.io.Serializable

Interface representing an option or parameter.

Version:

$Revision: 7 $

Author:

Richard Kirkby ([email protected])

Method Summary

Modifier and Type	Method	Description
Option	copy()	Gets a copy of this option
char	getCLIChar()	Gets the Command Line Interface text of this option
java.lang.String	getDefaultCLIString()	Gets the Command Line Interface text
java.lang.String	getName()	Gets the name of this option
java.lang.String	getPurpose()	Gets the purpose of this option
java.lang.String	getStateString()	Gets the state of this option in human readable form
java.lang.String	getValueAsCLIString()	Gets the value of a Command Line Interface text as a string
void	resetToDefault()	Resets this option to the default value
void	setValueViaCLIString(java.lang.String s)	Sets value of this option via the Command Line Interface text

Method Detail

getName

java.lang.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

java.lang.String getPurpose()

Gets the purpose of this option

Returns:

the purpose of this option

getDefaultCLIString

java.lang.String getDefaultCLIString()

Gets the Command Line Interface text

Returns:

the Command Line Interface text

setValueViaCLIString

void setValueViaCLIString(java.lang.String s)

Sets value of this option via the Command Line Interface text

Parameters:

s - the Command Line Interface text

getValueAsCLIString

java.lang.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

java.lang.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