de.caff.util.args

Interface SwitchOrArgument

All Known Subinterfaces:

Argument, Switch

All Known Implementing Classes:

AbstractBasicArgument, AbstractSimpleSwitch, MultipleArgument, SimpleOnOffSwitch, SimpleSwitch, SingleArgument, StringArgSwitch

public interface SwitchOrArgument

A command line argument or a command line switch.

Since:

January 27, 2019

Author:

Rammi

Method Summary

Modifier and Type	Method and Description
boolean	consumeArgument(java.lang.String arg) Read further arguments from the command line.
java.lang.String	getAppearance() Get the appearance of this switch or argument on the command line.
java.lang.String	getDescription() Get a short description for this switch.
boolean	isOptional() Is this argument optional?
boolean	isSwitch() Is this a switch?

Method Detail

isSwitch

boolean isSwitch()

Is this a switch?

Returns:

true: this is a switch and can be casted to Switch, false: this is a argument and can be casted to Argument

isOptional

boolean isOptional()

Is this argument optional? For switches order is basically ignored, but it is not allowed that non-optional arguments appear after optional ones

Returns:

true when this switch or argument is optional,
false if it is required

getAppearance

@NotNull
java.lang.String getAppearance()

Get the appearance of this switch or argument on the command line.

Returns:

appearance

getDescription

@NotNull
java.lang.String getDescription()

Get a short description for this switch.

Returns:

short description

consumeArgument

boolean consumeArgument(@NotNull
                        java.lang.String arg)

Read further arguments from the command line. The default implementation does not remove any arguments.

Parameters:

arg - argument

Returns:

if more arguments may be consumed