Uses of Interface
org.refcodes.cli.Synopsis
-
-
Uses of Synopsis in org.refcodes.cli
Subinterfaces of Synopsis in org.refcodes.cli Modifier and Type Interface Description interface
ArgsSyntax
TheArgsSyntax
interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree; simply extending theSyntaxable
interface and adding the functionality of providing access to the addedOperand
s (leafs).interface
Condition
Interface indicating that theArgsSyntax
semantically represents a condition which usally encapsulates otherSyntaxable
children.interface
Operand<T>
AnOperand
represents a value parsed from command line arguments.interface
Option<T>
AnOption
represents a command line option with the according option's value.interface
Syntaxable
ASyntaxable
defines the methods at least required when building a command line arguments syntax tree for traversing the syntax tree; either for parsing command line arguments or for constructing the command line arguments syntax.Classes in org.refcodes.cli that implement Synopsis Modifier and Type Class Description class
AbstractCondition
TheAbstractCondition
is an abstract implementation of theArgsSyntax
interface providing the boiler plate when implementing theArgsSyntax
interface as done by theAbstractCondition
's sub-classes.class
AbstractOperand<T>
TheAbstractOperand
is an abstract implementation of anOperand
providing the boiler plate when implementing theOperand
interface.class
AbstractOption<T>
TheAbstractOption
is an abstract implementation of anOption
providing the boiler plate when implementing theOption
interface.class
AllCondition
TheAllCondition
enforces that the encapsulatedSyntaxable
consumes all arguments passed via invoking itsSyntaxable.parseArgs(String[])
, else aSuperfluousArgsException
is thrown.class
AndCondition
AnAndCondition
contains (represents) a list ofArgsSyntax
(Syntaxable
) instances (nested by theAndCondition
) of which all are to be parsed successfully as of invoking theSyntaxable.parseArgs(String[], String[])
methods.class
AnyCondition
Any of the nestedArgsSyntax
conditions may match for theAnyCondition
to match, e.g. all of the nested conditions are optional.class
ArrayOperand<T>
Creates an array representation facade for the encapsulatedOperand
.class
ArrayOption<T>
Creates an array representation facade for the encapsulatedOption
.class
CasesCondition
TheCasesCondition
is anXorCondition
making sure that all possible cases inside theXorCondition
must(!)class
CharOption
class
CleanFlag
A predefined cleanFlag
: A predefinedFlag
gives itsCleanFlag.SHORT_OPTION
, itsCleanFlag.LONG_OPTION
as well as itsCleanFlag.ALIAS
an according semantics regarded by other subsystems.class
ConfigOption
TheConfigOption
represents anOption
holding a value specifying a configuration resource (file).class
DaemonFlag
A predefined daemonFlag
: A predefinedFlag
gives itsDaemonFlag.SHORT_OPTION
, itsDaemonFlag.LONG_OPTION
as well as itsDaemonFlag.ALIAS
an according semantics regarded by other subsystems.class
DebugFlag
A predefined debugFlag
: A predefinedFlag
gives itsDebugFlag.SHORT_OPTION
, itsDebugFlag.LONG_OPTION
as well as itsDebugFlag.ALIAS
an according semantics regarded by other subsystems.class
DoubleOption
class
EnumOption<T extends Enum<T>>
The Class EnumOption.class
FileOption
class
Flag
TheFlag
class implements theOption
interface for representing either atrue
or afalse
state: When a flag is provided to your command line arguments, then it is considered to betrue
, when it is omitted, then it is considered to befalse
as ofFlag.isEnabled()
.class
FloatOption
class
ForceFlag
A predefined forceFlag
: A predefinedFlag
gives itsForceFlag.SHORT_OPTION
, itsForceFlag.LONG_OPTION
as well as itsForceFlag.ALIAS
an according semantics regarded by other subsystems.class
HelpFlag
A predefined helpFlag
: A predefinedFlag
gives itsHelpFlag.SHORT_OPTION
, itsHelpFlag.LONG_OPTION
as well as itsHelpFlag.ALIAS
an according semantics regarded by other subsystems.class
InitFlag
A predefined initFlag
: A predefinedFlag
gives itsInitFlag.SHORT_OPTION
, itsInitFlag.LONG_OPTION
as well as itsInitFlag.ALIAS
an according semantics regarded by other subsystems.class
IntOption
class
LongOption
class
NoneOperand
TheNoneOperand
represents an empty set of arguments, e.g. no command line argument is being passed.class
Operation
TheOperation
is an argument representing a function or a method ("command") and is either provided or not provided as ofOperation.isEnabled()
.class
OptionCondition
class
OrCondition
AnOrCondition
represents a list ofArgsSyntax
(Syntaxable
) instances of which at least one must be parsed successfully when theSyntaxable
s'Syntaxable.parseArgs(String[], String[])
methods are invoked.class
QuietFlag
A predefined "be quiet"Flag
: A predefinedFlag
gives itsQuietFlag.SHORT_OPTION
, itsQuietFlag.LONG_OPTION
as well as itsQuietFlag.ALIAS
an according semantics regarded by other subsystems.class
StringOperand
class
StringOption
class
SysInfoFlag
A predefined system informationFlag
: A predefinedFlag
gives itsSysInfoFlag.SHORT_OPTION
, itsSysInfoFlag.LONG_OPTION
as well as itsSysInfoFlag.ALIAS
an according semantics regarded by other subsystems..class
VerboseFlag
A predefined verboseFlag
: A predefinedFlag
gives itsVerboseFlag.SHORT_OPTION
, itsVerboseFlag.LONG_OPTION
as well as itsVerboseFlag.ALIAS
an according semantics regarded by other subsystems.class
XorCondition
AnXorCondition
represents a list ofArgsSyntax
(Syntaxable
) instances of which only one is allowed to be parsed successfully when theSyntaxable.parseArgs(String[], String[])
methods are invoked.
-