moa.options

Class AbstractOption

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOption

All Implemented Interfaces:

Serializable, MOAObject, Option

Direct Known Subclasses:

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

public abstract class AbstractOption
extends AbstractMOAObject
implements Option

Abstract option.

Version:

$Revision: 7 $

Author:

Richard Kirkby (rkirkby@cs.waikato.ac.nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and 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 String	name Name of this option.
protected String	purpose Text of the purpose of this option.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Option	copy() This method produces a copy of this object.
char	getCLIChar() Gets the Command Line Interface text of this option
void	getDescription(StringBuilder sb, int indent) Returns a string representation of this object.
JComponent	getEditComponent() Gets the GUI component to edit
String	getName() Gets the name of this option
String	getPurpose() Gets the purpose of this option
String	getStateString() Gets the state of this option in human readable form
static boolean	nameIsLegal(String optionName) Gets whether the name is valid or not.
void	resetToDefault() Resets this option to the default value

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface moa.options.Option

getDefaultCLIString, getValueAsCLIString, setValueViaCLIString

Methods inherited from interface moa.MOAObject

measureByteSize

Field Detail

illegalNameCharacters

public static final char[] illegalNameCharacters

Array of characters not valid to use in option names.

name

protected String name

Name of this option.

cliChar

protected char cliChar

Command line interface text of this option.

purpose

protected String purpose

Text of the purpose of this option.

Constructor Detail

AbstractOption

public AbstractOption(String name,
              char cliChar,
              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(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 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 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 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: MOAObject

This method produces a copy of this object.

Specified by:

copy in interface MOAObject

Specified by:

copy in interface Option

Overrides:

copy in class AbstractMOAObject

Returns:

a copy of this object

getDescription

public void getDescription(StringBuilder sb,
                  int indent)

Description copied from interface: MOAObject

Returns a string representation of this object. Used in AbstractMOAObject.toString to give a string representation of the object.

Specified by:

getDescription in interface MOAObject

Parameters:

sb - the stringbuilder to add the description

indent - the number of characters to indent

getEditComponent

public JComponent getEditComponent()

Description copied from interface: Option

Gets the GUI component to edit

Specified by:

getEditComponent in interface Option

Returns:

the component to edit