org.maltparser.core.options.option

Class StringOption

java.lang.Object

org.maltparser.core.options.option.Option

org.maltparser.core.options.option.StringOption

All Implemented Interfaces:

java.lang.Comparable<Option>

public class StringOption
extends Option

A string option is an option that contains a string value.

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
StringOption(OptionGroup group, java.lang.String name, java.lang.String shortDescription, java.lang.String flag, java.lang.String usage, java.lang.String defaultValue) Creates a string option description

Method Summary

Modifier and Type	Method and Description
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

StringOption

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

Creates a string 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.

defaultValue - a default value string.

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

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Description copied from class: Option

Sets the default value for the option.

Specified by:

setDefaultValue in class Option

Parameters:

defaultValue - the string default value

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

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