votorola.g.option

Class Option

java.lang.Object

gnu.getopt.LongOpt

Option

All Implemented Interfaces:

Comparable<Option>

public class Option
extends gnu.getopt.LongOpt
implements Comparable<Option>

A formal command line option.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	argumentValue

Fields inherited from class gnu.getopt.LongOpt

flag, has_arg, name, NO_ARGUMENT, OPTIONAL_ARGUMENT, REQUIRED_ARGUMENT, val

Constructor Summary

Constructors

Constructor and Description
Option(String _name, int _has_arg) Constructs an Option.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOccurence(String _argumentValue) Adds an actual occurence of this formal option.
void	apply() Applies the option.
String	argumentValue() The value of the option argument from the last actual occurence of this option.
int	compareTo(Option other) Compares based on name.
boolean	equals(Object o) Compares based on name.
int	hashCode()
boolean	hasOccured() True iff this option has actually occured.
int	occurenceCount() The number of times this option has actually occured.
String	toString() The name of this option.

Methods inherited from class gnu.getopt.LongOpt

getFlag, getHasArg, getName, getVal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

argumentValue

protected String argumentValue

Constructor Detail

Option

public Option(String _name,
      int _has_arg)

Constructs an Option.

Method Detail

addOccurence

public final void addOccurence(String _argumentValue)

Adds an actual occurence of this formal option.

Parameters:

_argumentValue - the value of any argument that accompanies the occurence.

apply

public void apply()

Applies the option. This hook method is called once for each actual occurence of the option. Subclasses may override it to carry out specific actions. By default it does nothing.

argumentValue

public String argumentValue()

The value of the option argument from the last actual occurence of this option.

Returns:

the value from the last actual occurence, or null if there was none.

hasOccured

public boolean hasOccured()

True iff this option has actually occured.

occurenceCount

public int occurenceCount()

The number of times this option has actually occured.

compareTo

public int compareTo(Option other)

Compares based on name.

Specified by:

compareTo in interface Comparable<Option>

See Also:

LongOpt.getName()

equals

public boolean equals(Object o)

Compares based on name.

Overrides:

equals in class Object

See Also:

LongOpt.getName()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

The name of this option.

Overrides:

toString in class Object

See Also:

LongOpt.getName()