Package com.github.javacliparser

Class ListOption

java.lang.Object

com.github.javacliparser.AbstractOption

com.github.javacliparser.ListOption

All Implemented Interfaces:

Option, java.io.Serializable

public class ListOption
extends AbstractOption

List option.

Version:

$Revision: 7 $

Author:

Richard Kirkby ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Option[]	currentList
protected Option[]	defaultList
protected Option	expectedType
protected char	separatorChar

Fields inherited from class com.github.javacliparser.AbstractOption

cliChar, illegalNameCharacters, name, purpose

Constructor Summary

Constructors

Constructor	Description
ListOption(java.lang.String name, char cliChar, java.lang.String purpose, Option expectedType, Option[] defaultList, char separatorChar)

Method Summary

Modifier and Type	Method	Description
static Option[]	cliStringToOptionArray(java.lang.String s, char separator, Option expectedType)
java.lang.String	getDefaultCLIString()	Gets the Command Line Interface text
Option[]	getList()
java.lang.String	getValueAsCLIString()	Gets the value of a Command Line Interface text as a string
static java.lang.String	optionArrayToCLIString(Option[] os, char separator)
void	setList(Option[] optList)
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

currentList

protected Option[] currentList

expectedType

protected Option expectedType

defaultList

protected Option[] defaultList

separatorChar

protected char separatorChar

Constructor Detail

ListOption

public ListOption(java.lang.String name,
                  char cliChar,
                  java.lang.String purpose,
                  Option expectedType,
                  Option[] defaultList,
                  char separatorChar)

Method Detail

setList

public void setList(Option[] optList)

getList

public Option[] getList()

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

cliStringToOptionArray

public static Option[] cliStringToOptionArray(java.lang.String s,
                                              char separator,
                                              Option expectedType)

optionArrayToCLIString

public static java.lang.String optionArrayToCLIString(Option[] os,
                                                      char separator)