monq.clifj

Class EnumOption

java.lang.Object

monq.clifj.Option

monq.clifj.EnumOption

public class EnumOption
extends Option

is a command line option with String valued arguments from a small set of given strings.

Author:

© 2005 Harald Kirsch

Constructor Summary

Constructors

Constructor and Description
EnumOption(java.lang.String opt, java.lang.String name, java.lang.String usage, int cmin, int cmax, java.lang.String allowed)
EnumOption(java.lang.String opt, java.lang.String name, java.lang.String usage, int cmin, int cmax, java.lang.String allowed, java.lang.String[] deFault) creates an option which accepts string values from small enumerated set of values.

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.

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

EnumOption

public EnumOption(java.lang.String opt,
                  java.lang.String name,
                  java.lang.String usage,
                  int cmin,
                  int cmax,
                  java.lang.String allowed,
                  java.lang.String[] deFault)
           throws CommandlineException

creates an option which accepts string values from small enumerated set of values. Parameter allowed must contain the enumerated values as follows: The first character in allowed is used as a separator. Then allowed is split at every position of where the separator appears, and the resulting substrings make up the enumerated values. For example "|one|two|three" defines the enumeration {"one", "two", "three"}.

Notes:

• No effort is made to check whether the given strings are unique.
• A trailing separator or two consecutive separators generate the empty string.

Throws:

CommandlineException - if the defaults don't match the requirements

EnumOption

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

Method Detail

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.