Package com.github.javacliparser

Class MultiChoiceOption

java.lang.Object

com.github.javacliparser.AbstractOption

com.github.javacliparser.MultiChoiceOption

All Implemented Interfaces:

Option, java.io.Serializable

Direct Known Subclasses:

EditableMultiChoiceOption

public class MultiChoiceOption
extends AbstractOption

Multi choice option.

Version:

$Revision: 7 $

Author:

Richard Kirkby ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	chosenOptionIndex
protected int	defaultOptionIndex
protected java.lang.String[]	optionDescriptions
protected java.lang.String[]	optionLabels

Fields inherited from class com.github.javacliparser.AbstractOption

cliChar, illegalNameCharacters, name, purpose

Constructor Summary

Constructors

Constructor	Description
MultiChoiceOption(java.lang.String name, char cliChar, java.lang.String purpose, java.lang.String[] optionLabels, java.lang.String[] optionDescriptions, int defaultOptionIndex)

Method Summary

Modifier and Type	Method	Description
int	getChosenIndex()
java.lang.String	getChosenLabel()
java.lang.String	getDefaultCLIString()	Gets the Command Line Interface text
int	getDefaultOptionIndex()
java.lang.String[]	getOptionDescriptions()
java.lang.String[]	getOptionLabels()
java.lang.String	getValueAsCLIString()	Gets the value of a Command Line Interface text as a string
void	setChosenIndex(int index)
void	setChosenLabel(java.lang.String label)
void	setValueViaCLIString(java.lang.String s)	Sets value of this option via the Command Line Interface text

Methods inherited from class com.github.javacliparser.AbstractOption

copy, getCLIChar, getName, getPurpose, getStateString, nameIsLegal, resetToDefault

Methods inherited from class java.lang.Object

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

Field Detail

optionLabels

protected java.lang.String[] optionLabels

optionDescriptions

protected java.lang.String[] optionDescriptions

defaultOptionIndex

protected int defaultOptionIndex

chosenOptionIndex

protected int chosenOptionIndex

Constructor Detail

MultiChoiceOption

public MultiChoiceOption(java.lang.String name,
                         char cliChar,
                         java.lang.String purpose,
                         java.lang.String[] optionLabels,
                         java.lang.String[] optionDescriptions,
                         int defaultOptionIndex)

Method Detail

getDefaultCLIString

public java.lang.String getDefaultCLIString()

Description copied from interface: Option

Gets the Command Line Interface text

Returns:

the Command Line Interface text

getValueAsCLIString

public java.lang.String getValueAsCLIString()

Description copied from interface: Option

Gets the value of a Command Line Interface text as a string

Returns:

the string with the value of the Command Line Interface text

setValueViaCLIString

public void setValueViaCLIString(java.lang.String s)

Description copied from interface: Option

Sets value of this option via the Command Line Interface text

Parameters:

s - the Command Line Interface text

setChosenLabel

public void setChosenLabel(java.lang.String label)

setChosenIndex

public void setChosenIndex(int index)

getOptionLabels

public java.lang.String[] getOptionLabels()

getOptionDescriptions

public java.lang.String[] getOptionDescriptions()

getDefaultOptionIndex

public int getDefaultOptionIndex()

getChosenLabel

public java.lang.String getChosenLabel()

getChosenIndex

public int getChosenIndex()