com.eibus.util

Class CommandLine.ValidOptions

java.lang.Object

com.eibus.util.CommandLine.ValidOptions

Enclosing class:

CommandLine

public static class CommandLine.ValidOptions
extends java.lang.Object

This class is used to store and check which options are valid.

Method Summary

Modifier and Type	Method and Description
void	allow(java.util.List<java.lang.String> flagOptions, java.util.List<java.lang.String> flargOptions, java.util.List<java.lang.String> argOptions) Make the given options known and allowed.
void	allowArg(java.lang.String option) Make arg option known and allowed.
void	allowFlag(java.lang.String option) Make flag option known and allowed.
void	allowFlarg(java.lang.String option) Make flarg option known and allowed.
void	allowJust(java.util.List<java.lang.String> flagOptions, java.util.List<java.lang.String> flargOptions, java.util.List<java.lang.String> argOptions) Make the given options known and allowed, and disallow all others.
void	allowOption(java.lang.String option, boolean mayHaveAnArg, boolean mayHaveNoArg) Make option known and allowed.
void	allowUnknown() Allow all kinds of unknown options.
void	allowUnknown(boolean mayHaveAnArg, boolean mayHaveNoArg) Allow unknown options.
void	disallow(java.lang.String option) Make option known and disallowed.
void	disallowAll() Make all options unknown and disallowed.
void	disallowUnknown() Disallow all unknown options.
boolean	mayHaveAnArg(java.lang.String option) Check whether an option may have an argument.
boolean	mayHaveNoArg(java.lang.String option) Check whether an option may be without argument.
void	reset() Reset this instance to its initial state.

Methods inherited from class java.lang.Object

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

Method Detail

allowOption

public void allowOption(java.lang.String option,
                        boolean mayHaveAnArg,
                        boolean mayHaveNoArg)

Make option known and allowed.

Parameters:

option - the option

mayHaveAnArg - may the option have an argument?

mayHaveNoArg - may the option be without argument?

allowArg

public void allowArg(java.lang.String option)

Make arg option known and allowed.

Parameters:

option - the option

allowFlag

public void allowFlag(java.lang.String option)

Make flag option known and allowed.

Parameters:

option - the option

allowFlarg

public void allowFlarg(java.lang.String option)

Make flarg option known and allowed.

Parameters:

option - the option

allow

public final void allow(java.util.List<java.lang.String> flagOptions,
                        java.util.List<java.lang.String> flargOptions,
                        java.util.List<java.lang.String> argOptions)

Make the given options known and allowed.

Parameters:

flagOptions - the flag options allowed

flargOptions - the flarg options allowed

argOptions - the flarg options allowed

Throws:

CommandLine.ParseException - the format of the command line is not valid

allowJust

public final void allowJust(java.util.List<java.lang.String> flagOptions,
                            java.util.List<java.lang.String> flargOptions,
                            java.util.List<java.lang.String> argOptions)

Make the given options known and allowed, and disallow all others.

Parameters:

flagOptions - the flag options allowed

flargOptions - the flarg options allowed

argOptions - the flarg options allowed

Throws:

CommandLine.ParseException - the format of the command line is not valid

allowUnknown

public void allowUnknown()

Allow all kinds of unknown options.

allowUnknown

public final void allowUnknown(boolean mayHaveAnArg,
                               boolean mayHaveNoArg)

Allow unknown options.

Parameters:

mayHaveAnArg - may an unknown option have an argument?

mayHaveNoArg - may an unknown option be without argument?

disallow

public void disallow(java.lang.String option)

Make option known and disallowed. This is only useful when unknown options are allowed.

Parameters:

option - the option

See Also:

CommandLine#ValidOptions#allowUnknown

disallowAll

public final void disallowAll()

Make all options unknown and disallowed.

disallowUnknown

public final void disallowUnknown()

Disallow all unknown options.

mayHaveAnArg

public boolean mayHaveAnArg(java.lang.String option)

Check whether an option may have an argument.

Parameters:

option - the option

mayHaveNoArg

public boolean mayHaveNoArg(java.lang.String option)

Check whether an option may be without argument.

Parameters:

option - the option

reset

public final void reset()

Reset this instance to its initial state.