Package com.github.javacliparser

Class AbstractOption

java.lang.Object

com.github.javacliparser.AbstractOption

All Implemented Interfaces:

Option, java.io.Serializable

Direct Known Subclasses:

AbstractClassOption, AbstractClassOption, FlagOption, FloatOption, IntOption, ListOption, MultiChoiceOption, StringOption

public abstract class AbstractOption
extends java.lang.Object
implements Option

Abstract option.

Version:

$Revision: 7 $

Author:

Richard Kirkby ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected char	cliChar	Command line interface text of this option.
static char[]	illegalNameCharacters	Array of characters not valid to use in option names.
protected java.lang.String	name	Name of this option.
protected java.lang.String	purpose	Text of the purpose of this option.

Constructor Summary

Constructors

Constructor	Description
AbstractOption(java.lang.String name, char cliChar, java.lang.String purpose)	Creates a new instance of an abstract option given its class name, command line interface text and its purpose.

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	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
static boolean	nameIsLegal(java.lang.String optionName)	Gets whether the name is valid or not.
void	resetToDefault()	Resets this option to the default value

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javacliparser.Option

getDefaultCLIString, getValueAsCLIString, setValueViaCLIString

Field Detail

illegalNameCharacters

public static final char[] illegalNameCharacters

Array of characters not valid to use in option names.

name

protected java.lang.String name

Name of this option.

cliChar

protected char cliChar

Command line interface text of this option.

purpose

protected java.lang.String purpose

Text of the purpose of this option.

Constructor Detail

AbstractOption

public AbstractOption(java.lang.String name,
                      char cliChar,
                      java.lang.String purpose)

Creates a new instance of an abstract option given its class name, command line interface text and its purpose.

Parameters:

name - the name of this option

cliChar - the command line interface text

purpose - the text describing the purpose of this option

Method Detail

nameIsLegal

public static boolean nameIsLegal(java.lang.String optionName)

Gets whether the name is valid or not.

Parameters:

optionName - the name of the option

Returns:

true if the name that not contain any illegal character

getName

public java.lang.String getName()

Description copied from interface: Option

Gets the name of this option

Specified by:

getName in interface Option

Returns:

the name of this option

getCLIChar

public char getCLIChar()

Description copied from interface: Option

Gets the Command Line Interface text of this option

Specified by:

getCLIChar in interface Option

Returns:

the Command Line Interface text

getPurpose

public java.lang.String getPurpose()

Description copied from interface: Option

Gets the purpose of this option

Specified by:

getPurpose in interface Option

Returns:

the purpose of this option

resetToDefault

public void resetToDefault()

Description copied from interface: Option

Resets this option to the default value

Specified by:

resetToDefault in interface Option

getStateString

public java.lang.String getStateString()

Description copied from interface: Option

Gets the state of this option in human readable form

Specified by:

getStateString in interface Option

Returns:

the string with state of this option in human readable form

copy

public Option copy()

Description copied from interface: Option

Gets a copy of this option

Specified by:

copy in interface Option

Returns:

the copy of this option