Package org.refcodes.console
Interface SyntaxUsage
-
- All Known Subinterfaces:
Condition
,Operand<T>
,Option<T>
,Syntaxable
- All Known Implementing Classes:
AbstractCondition
,AbstractOperand
,AbstractOption
,AndCondition
,DebugFlag
,DoubleOption
,EnumOption
,FileOption
,Flag
,FloatOption
,ForceFlag
,HelpFlag
,IntegerOption
,LongOption
,OptionalCondition
,OrCondition
,QuietFlag
,SingleOptionCondition
,StringOperand
,StringOption
,SysInfoFlag
,VerboseFlag
,XorCondition
public interface SyntaxUsage
TheSyntaxUsage
interface defines those methods required to create a human readable usageString
from the implementing instance.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods 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 rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String)
is called from inside aSyntaxable
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 rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String)
is called from inside aSyntaxable
hierarchy.
-
-
-
Method Detail
-
toUsage
default String toUsage()
-
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 rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String)
is called from inside aSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
or an encapsulating and different type, then the applicable method to be called istoUsage(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.- Returns:
- The human readable (verbose) command line arguments syntax.
-
toUsage
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 rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String)
is called from inside aSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
or an encapsulating and different type, then the applicable method to be called istoUsage(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Parameters:
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.- Returns:
- The human readable (verbose) command line arguments syntax.
-
-