monq.clifj

Class Option

java.lang.Object

monq.clifj.Option

Direct Known Subclasses:

BooleanOption, EnumOption, LongOption

public class Option
extends java.lang.Object

is a general command line option with zero or more string values.

Author:

© 2005-2007 Harald Kirsch

Constructor Summary

Constructors

Constructor and Description
Option(java.lang.String opt, java.lang.String name, java.lang.String usage, int cmin, int cmax) creates a command line option.
Option(java.lang.String opt, java.lang.String name, java.lang.String usage, int cmin, int cmax, java.lang.Object[] defalt) creates a command line option with default.

Method Summary

Modifier and Type	Method and Description
boolean	available() returns true if the option was found on the command line or has default values.
java.lang.Object	getValue() returns the first element of the vector returned by getValues.
java.util.List<java.lang.Object>	getValues() returns the arguments found on the command line or set as a default for this option.
Option	required() converts the option into a required command line argument and Commandline.parse() will check this.
Option	setDefault(java.lang.String[] defalt) defines default values for this Option.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Option

public Option(java.lang.String opt,
              java.lang.String name,
              java.lang.String usage,
              int cmin,
              int cmax)

creates a command line option.

Parameters:

opt - is the option string introducing this option on the command line and normally starts with a dash, i.e. "-v".

name - is a symbolic name for the variable initialized by the option, only used in usage output.

usage - is a one liner describing the intend of this option

cmin - is the minimum number of command line arguments for this option

cmax - is the maximum number of command line arguments for this option

Option

public Option(java.lang.String opt,
              java.lang.String name,
              java.lang.String usage,
              int cmin,
              int cmax,
              java.lang.Object[] defalt)
       throws CommandlineException

creates a command line option with default. This constructor first calls the constructor without default and then calls setDefalt(java.lang.Object[]) to set the default values.

Throws:

CommandlineException - if the number of default values is wrong or if they are not of type String.

Method Detail

setDefault

public final Option setDefault(java.lang.String[] defalt)
                        throws CommandlineException

defines default values for this Option.

Returns:

this

Throws:

CommandlineException - if the value does not conform to check(java.lang.Object) or if there are

java.lang.IllegalArgumentException - if defalt contains too many values

required

public Option required()

converts the option into a required command line argument and Commandline.parse() will check this.

Returns:

this

available

public boolean available()

returns true if the option was found on the command line or has default values.

getValues

public java.util.List<java.lang.Object> getValues()

returns the arguments found on the command line or set as a default for this option. May be null. The elements of the resulting vector are of type String or whatever was passed in as the defalt parameter of the constructor. For subclasses of Option, different types may be returned.

getValue

public java.lang.Object getValue()

returns the first element of the vector returned by getValues. This is a convenience method normally to be used only for options with exactly one parameter. If the option is indeed "optional", a call to available() should preceed this call.