SyntaxUsage (org.refcodes:refcodes-console 2.0.2 API)

All Known Subinterfaces:

Condition, Operand<T>, Option<T>, Syntaxable

All Known Implementing Classes:

AbstractCondition, AbstractOperand, AbstractOption, AndCondition, DebugFlag, EnumOption, Flag, ForceFlag, HelpFlag, IntegerOption, LongOption, OptionalCondition, OrCondition, QuietFlag, StringOperand, StringOption, SysInfoFlag, VerboseFlag, XorCondition
```
public interface SyntaxUsage
```
The SyntaxUsage interface defines those methods required to create a human readable usage String from the implementing instance.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default java.lang.String`	`toUsage()`
`java.lang.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.

- Method Detail
  - toUsage
```
default java.lang.String toUsage()
```
  - toUsage
```
java.lang.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 Syntaxables, 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.
    
    Parameters:
    
    aSyntaxNotation - The syntax notation used for generating the command line arguments syntax.
    
    Returns:
    
    The human readable (verbose) command line arguments syntax.