de.carne.util.cmdline

Class CmdLine

java.lang.Object

de.carne.util.cmdline.CmdLine

public final class CmdLine
extends java.lang.Object

Utility class for command line evaluation.

Constructor Summary

Constructors

Constructor and Description
CmdLine(java.lang.Iterable<java.lang.String> args) Construct CmdLine.
CmdLine(java.lang.String[] args) Construct CmdLine.

Method Summary

Modifier and Type	Method and Description
void	eval() Evaluate the command line and invoke the corresponding actions.
CmdLineAction	namedOptionAction(java.util.function.BiConsumer<java.lang.String,java.lang.String> consumer) Register a named option action.
CmdLineAction	switchAction(java.util.function.Consumer<java.lang.String> consumer) Register a switch action.
java.lang.String	toString()
void	unknownArgument(java.util.function.Consumer<java.lang.String> consumer) Register an action for unknown arguments.
void	unnamedOptionAction(java.util.function.Consumer<java.lang.String> consumer) Register an unnamed option action.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdLine

public CmdLine(java.lang.String[] args)

Construct CmdLine.

Parameters:

args - The command line to evaluate.

CmdLine

public CmdLine(java.lang.Iterable<java.lang.String> args)

Construct CmdLine.

Parameters:

args - The command line to evaluate.

Method Detail

eval

public void eval()
          throws CmdLineException

Evaluate the command line and invoke the corresponding actions.

Throws:

CmdLineException - If one of the actions fails with a CmdLineActionException.

switchAction

public CmdLineAction switchAction(java.util.function.Consumer<java.lang.String> consumer)

Register a switch action.

Parameters:

consumer - The consumer to be invoked with the argument if this action matches during command line evaluation.

Returns:

The registered action.

See Also:

CmdLineAction

namedOptionAction

public CmdLineAction namedOptionAction(java.util.function.BiConsumer<java.lang.String,java.lang.String> consumer)

Register a named option action.

Parameters:

consumer - The consumer to be invoked with the argument and the option if this action matches during command line evaluation.

Returns:

The registered action.

See Also:

CmdLineAction

unnamedOptionAction

public void unnamedOptionAction(java.util.function.Consumer<java.lang.String> consumer)

Register an unnamed option action.

Parameters:

consumer - The consumer to be invoked with the option if this action matches during command line evaluation.

unknownArgument

public void unknownArgument(java.util.function.Consumer<java.lang.String> consumer)

Register an action for unknown arguments.

Parameters:

consumer - The consumer to be invoked if an argument is encountered during evaluation which matches no action.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object