de.carne.util.cmdline

Class CmdLineAction

java.lang.Object

de.carne.util.cmdline.CmdLineAction

public abstract class CmdLineAction
extends java.lang.Object

This class represents an action associated with a set of recognized command line args.

An action can either be a switch (e.g. --switch) or an option (e.g. {«code --option value}).

See Also:

CmdLineProcessor.onSwitch(java.util.function.Consumer), CmdLineProcessor.onOption(java.util.function.BiConsumer)

Constructor Summary

Constructors

Constructor and Description
CmdLineAction()

Method Summary

Modifier and Type	Method and Description
CmdLineAction	arg(java.lang.String arg) Add an argument string that should be trigger this CmdLineAction.
boolean	contains(java.lang.String arg) Check whether the submitted argument string is a trigger for this CmdLineAction.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdLineAction

public CmdLineAction()

Method Detail

arg

public CmdLineAction arg(java.lang.String arg)

Add an argument string that should be trigger this CmdLineAction.

Parameters:

arg - The argument string to be associated with this CmdLineAction.

Returns:

The updated CmdLineAction.

contains

public boolean contains(java.lang.String arg)

Check whether the submitted argument string is a trigger for this CmdLineAction.

Parameters:

arg - The argument string to check.

Returns:

true if the argument string is associated with this CmdLineAction.

See Also:

arg(String)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object