de.carne.util.cmdline

Class CmdLineAction

java.lang.Object

de.carne.util.cmdline.CmdLineAction

public abstract class CmdLineAction
extends java.lang.Object

This class is used to define an action for command line evaluation.

An action can be of three different kinds:

• Switch (e.g. --verbose)
• Named Option (e.g. --file some_file.txt)
• Unnamed Option (e.g. some_file.txt)

An action can be associated with one or more arguments (e.g --file and -f). The parsing algorithm in class CmdLine assumes that arguments prefixed with a single '-' are one char only (e.g. -f) or all other arguments are either an unnamed option or are prefixed with '--' (e.g. --file).

See Also:

CmdLine.switchAction(java.util.function.Consumer), CmdLine.namedOptionAction(java.util.function.BiConsumer), CmdLine.unnamedOptionAction(java.util.function.Consumer)

Constructor Summary

Constructors

Constructor and Description
CmdLineAction()

Method Summary

Modifier and Type	Method and Description
CmdLineAction	arg(java.lang.String arg) Assign an argument string to this action.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdLineAction

public CmdLineAction()

Method Detail

arg

public CmdLineAction arg(java.lang.String arg)

Assign an argument string to this action.

Parameters:

arg - The argument string to add.

Returns:

The updated CmdLineAction.