monq.clifj

Class LongOption

java.lang.Object

monq.clifj.Option

monq.clifj.LongOption

public class LongOption
extends Option

is a command line option with long valued arguments.

Author:

© 2005-2007 Harald Kirsch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	addRestrictions(java.lang.String s) override in subclass to describe restrictions applied to values, like numerical range.
java.lang.Object	check(java.lang.Object v) checks if the given Object is a valid value for this option or can be converted to one.
java.lang.String	getTypeName()

Methods inherited from class monq.clifj.Option

available, getValue, getValues, required, setDefault

Methods inherited from class java.lang.Object

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

Constructor Detail

LongOption

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

creates a command line option with default.

Throws:

CommandlineException - if the number of defaults is wrong or they are not of type Long or String or they fall outside the given ranges.

LongOption

public LongOption(java.lang.String opt,
                  java.lang.String name,
                  java.lang.String usage,
                  int cmin,
                  int cmax,
                  long min,
                  long max)

Method Detail

getTypeName

public java.lang.String getTypeName()

check

public java.lang.Object check(java.lang.Object v)
                       throws CommandlineException

Description copied from class: Option

checks if the given Object is a valid value for this option or can be converted to one. This method converts the value, if possible and necessary and returns the resulting Object.

Hint: Subclasses must override this method to make sure the right objects are stored.

Throws:

CommandlineException - if the value does not meet the requirements for this option (e.g. wrong type, value too large) and cannot be (easily) converted.

addRestrictions

public java.lang.String addRestrictions(java.lang.String s)

Description copied from class: Option

override in subclass to describe restrictions applied to values, like numerical range. The restrictions should describe what check() checks.