org.maltparser.core.options.option

Class EnumOption

java.lang.Object

org.maltparser.core.options.option.Option

org.maltparser.core.options.option.EnumOption

All Implemented Interfaces:

java.lang.Comparable<Option>

public class EnumOption
extends Option

An enumerate option is an option that can only contain string value, which is in the legal value set.

Since:

1.0

Author:

Johan Hall

Field Summary

Fields inherited from class org.maltparser.core.options.option.Option

BOTH, NONE, PROCESS, SAVE, TRAIN

Constructor Summary

Constructors

Constructor and Description
EnumOption(OptionGroup group, java.lang.String name, java.lang.String shortDescription, java.lang.String flag, java.lang.String usage) Creates an enumerate option description

Method Summary

Modifier and Type	Method and Description
void	addLegalValue(java.lang.String value) Adds a legal value without a description
void	addLegalValue(java.lang.String value, java.lang.String desc) Adds a legal value
java.lang.Object	getDefaultValueObject() Returns the object for the default value for option.
java.lang.String	getDefaultValueString() Returns a string representation of the default value.
java.lang.String	getStringRepresentation(java.lang.Object value) Returns a string representation of the option value.
java.lang.Object	getValueObject(java.lang.String value) Returns the corresponding object for the option value (specified as a string value).
void	setDefaultValue(java.lang.String defaultValue) Sets the default value for the option.
java.lang.String	toString()

Methods inherited from class org.maltparser.core.options.option.Option

compareTo, getFlag, getGroup, getName, getShortDescription, getUsage, isAmbiguous, setAmbiguous, setFlag, setUsage, setUsage

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumOption

public EnumOption(OptionGroup group,
                  java.lang.String name,
                  java.lang.String shortDescription,
                  java.lang.String flag,
                  java.lang.String usage)
           throws MaltChainedException

Creates an enumerate option description

Parameters:

group - a reference to the option group.

name - the name of the option.

shortDescription - a short description of the option.

flag - a short string that can be used in the command line.

usage - a string that explains the usage of the option.

Throws:

OptionException

MaltChainedException

Method Detail

getValueObject

public java.lang.Object getValueObject(java.lang.String value)
                                throws MaltChainedException

Description copied from class: Option

Returns the corresponding object for the option value (specified as a string value).

Specified by:

getValueObject in class Option

Parameters:

value - the string option value

Returns:

the corresponding object for the option value (specified as a string value).

Throws:

OptionException

MaltChainedException

getDefaultValueObject

public java.lang.Object getDefaultValueObject()
                                       throws MaltChainedException

Description copied from class: Option

Returns the object for the default value for option.

Specified by:

getDefaultValueObject in class Option

Returns:

the object for the default value for option.

Throws:

OptionException

MaltChainedException

getDefaultValueString

public java.lang.String getDefaultValueString()

Description copied from class: Option

Returns a string representation of the default value.

Specified by:

getDefaultValueString in class Option

Returns:

a string representation of the default value

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
                     throws MaltChainedException

Description copied from class: Option

Sets the default value for the option.

Specified by:

setDefaultValue in class Option

Parameters:

defaultValue - the string default value

Throws:

OptionException

MaltChainedException

addLegalValue

public void addLegalValue(java.lang.String value,
                          java.lang.String desc)
                   throws MaltChainedException

Adds a legal value

Parameters:

value - a legal value name

desc - a short description of the legal value

Throws:

OptionException

MaltChainedException

addLegalValue

public void addLegalValue(java.lang.String value)
                   throws MaltChainedException

Adds a legal value without a description

Parameters:

value - a legal value name

Throws:

OptionException

MaltChainedException

getStringRepresentation

public java.lang.String getStringRepresentation(java.lang.Object value)

Description copied from class: Option

Returns a string representation of the option value.

Specified by:

getStringRepresentation in class Option

Parameters:

value - an option value object

Returns:

a string representation of the option value, if the option value could not be found null is returned.

toString

public java.lang.String toString()

Overrides:

toString in class Option