Condition
, Operand<T>
, Option<T>
, Syntaxable
AbstractCondition
, AbstractOperand
, AbstractOption
, AndCondition
, ArrayOperand
, ArrayOption
, CharOption
, DebugFlag
, DoubleOption
, EnumOption
, FileOption
, Flag
, FloatOption
, ForceFlag
, HelpFlag
, IntOption
, LongOption
, Operation
, OptionalCondition
, OptionConditionFacade
, OrCondition
, QuietFlag
, StringOperand
, StringOption
, SysInfoFlag
, VerboseFlag
, XorCondition
public interface SyntaxUsage
SyntaxUsage
interface defines those methods required to create a
human readable usage String
from the implementing instance.Modifier and Type | Method | Description |
---|---|---|
default String |
toUsage() |
|
default String |
toUsage(SyntaxNotation aSyntaxNotation) |
Returns the human readable (verbose) syntax of implementing class
ATTENTION: As of different parenthesis settings for some notations
regarding the root
Syntaxable and the child Syntaxable s,
the method Syntaxable.toSyntax(SyntaxNotation, String, String) is
called from inside a Syntaxable hierarchy. |
String |
toUsage(SyntaxNotation aSyntaxNotation,
String aOptionEscCode,
String aResetEscCode) |
Returns the human readable (verbose) syntax of implementing class
ATTENTION: As of different parenthesis settings for some notations
regarding the root
Syntaxable and the child Syntaxable s,
the method Syntaxable.toSyntax(SyntaxNotation, String, String) is
called from inside a Syntaxable hierarchy. |
default String toUsage()
default String toUsage(SyntaxNotation aSyntaxNotation)
Syntaxable
and the child Syntaxable
s,
the method Syntaxable.toSyntax(SyntaxNotation, String, String)
is
called from inside a Syntaxable
hierarchy. In case the syntax is
to be retrieved from the root Syntaxable
or an encapsulating and
different type, then the applicable method to be called is
toUsage(SyntaxNotation)
, as for some notations it will for
example not create the most outer braces.aSyntaxNotation
- The syntax notation used for generating the
command line arguments syntax.String toUsage(SyntaxNotation aSyntaxNotation, String aOptionEscCode, String aResetEscCode)
Syntaxable
and the child Syntaxable
s,
the method Syntaxable.toSyntax(SyntaxNotation, String, String)
is
called from inside a Syntaxable
hierarchy. In case the syntax is
to be retrieved from the root Syntaxable
or an encapsulating and
different type, then the applicable method to be called is
toUsage(SyntaxNotation)
, as for some notations it will for
example not create the most outer braces.aSyntaxNotation
- The syntax notation used for generating the
command line arguments syntax.aOptionEscCode
- The escape code to be used when processing an
option, e.g. this can be an ANSI Escape-Code to highlight the
option parameters (for example "--help", "-q" and so on).aResetEscCode
- The escape code to close (reset) any Escape-Code
being set before.Copyright © 2021. All rights reserved.