public interface SyntaxUsage
SyntaxUsage
interface defines those methods required to create a
human readable usage String
from the implementing instance.Modifier and Type | Method and Description |
---|---|
default String |
toUsage() |
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) is called from
inside a Syntaxable hierarchy. |
default String toUsage()
String toUsage(SyntaxNotation aSyntaxNotation)
Syntaxable
and the child Syntaxable
s,
the method Syntaxable.toSyntax(SyntaxNotation)
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.Copyright © 2018. All rights reserved.