common.cmdline
Class StringListOption

java.lang.Object
  common.cmdline.AbstractOption
      common.cmdline.StringListOption

All Implemented Interfaces:

Option

public class StringListOption
extends AbstractOption

Option that can occur multiple times on the command line with a string argument, yielding a list of strings. The order of strings in the list is the order in which they were given on the command line. The default value of a string list option is an empty list.

Field Summary

Fields inherited from class common.cmdline.AbstractOption

DOC_OFFSET, longForms, occurred, shortForms

Constructor Summary

StringListOption(java.lang.String shortForm, java.lang.String longForm, java.lang.String docStr)
Creates a string list option and registers it with the Parser class.

Method Summary

boolean	expectsValue() Returns true if this option expects a value on the command line.
java.lang.String	getUsageString() Returns a string that documents the option.
java.util.List	getValue() Returns the values specified on the command line for this option, or an empty list if the option did not occur.
void	recordOccurrence(java.lang.String form, java.lang.String valueStr) This default implementation prints a warning if this option has already been occurred.

Methods inherited from class common.cmdline.AbstractOption

getLongForms, getShortForms, toString, wasPresent

Methods inherited from class java.lang.Object

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

Constructor Detail

StringListOption

public StringListOption(java.lang.String shortForm,
                        java.lang.String longForm,
                        java.lang.String docStr)

Creates a string list option and registers it with the Parser class.

Parameters:

shortForm - single-character form of this option, or null for an option with no short form

longForm - long form of this option, or null for an option with no long form.

docStr - short (preferably less than 40 characters) string specifying what happens when this option is "<s>"

Method Detail

expectsValue

public boolean expectsValue()

Description copied from interface: Option

Returns true if this option expects a value on the command line.

recordOccurrence

public void recordOccurrence(java.lang.String form,
                             java.lang.String valueStr)

Description copied from class: AbstractOption

This default implementation prints a warning if this option has already been occurred. It also sets the occurred member variable to true. However, it does not parse or record the value.

Specified by:

recordOccurrence in interface Option

Overrides:

recordOccurrence in class AbstractOption

Parameters:

form - specifies the particular long or short form of the option that was used

valueStr - the given value, or null if no value was given. The parser will only pass null for this parameter if expectsValue returns false; otherwise, if the value is missing, the parser will not call this method.

getUsageString

public java.lang.String getUsageString()

Description copied from interface: Option

Returns a string that documents the option. This string should fit on one 80-column line.

getValue

public java.util.List getValue()

Returns the values specified on the command line for this option, or an empty list if the option did not occur.

Returns:

List of String