MaltParser 1.4.1

org.maltparser.core.options.option
Class StringOption

java.lang.Object
  extended by org.maltparser.core.options.option.Option
      extended by org.maltparser.core.options.option.StringOption
All Implemented Interfaces:
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
StringOption(OptionGroup group, String name, String shortDescription, String flag, String usage, String defaultValue)
          Creates a string option description
 
Method Summary
 Object getDefaultValueObject()
          Returns the object for the default value for option.
 String getDefaultValueString()
          Returns a string representation of the default value.
 String getStringRepresentation(Object value)
          Returns a string representation of the option value.
 Object getValueObject(String value)
          Returns the corresponding object for the option value (specified as a string value).
 void setDefaultValue(String defaultValue)
          Sets the default value for the option.
 String toString()
           
 
Methods inherited from class org.maltparser.core.options.option.Option
compareTo, getFlag, getGroup, getName, getShortDescription, getUsage, isAmbiguous, setAmbiguous, setFlag, setGroup, setName, setShortDescription, 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,
                    String name,
                    String shortDescription,
                    String flag,
                    String usage,
                    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 Object getValueObject(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 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(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 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 String getStringRepresentation(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 String toString()
Overrides:
toString in class Option

MaltParser 1.4.1

Copyright 2007-2010 Johan Hall, Jens Nilsson and Joakim Nivre.