Uses of Enum Class
org.refcodes.cli.SyntaxNotation
-
Uses of SyntaxNotation in org.refcodes.cli
Modifier and TypeMethodDescriptiondefault SyntaxNotation
SyntaxMetricsAccessor.SyntaxMetricsProperty.letSyntaxMetrics
(SyntaxNotation aSyntaxNotation) This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenSyntaxNotation
(setter) as ofSyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxNotation)
and returns the very same value (getter).static SyntaxNotation
SyntaxNotation.toSyntaxNotation
(String aValue) Retrieves aSyntaxNotation
depending on the given string, ignoring the case as well as being graceful regarding "-" and "_",.static SyntaxNotation
Returns the enum constant of this class with the specified name.static SyntaxNotation[]
SyntaxNotation.values()
Returns an array containing the constants of this enum class, in the order they are declared.Modifier and TypeMethodDescriptiondefault SyntaxNotation
SyntaxMetricsAccessor.SyntaxMetricsProperty.letSyntaxMetrics
(SyntaxNotation aSyntaxNotation) This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenSyntaxNotation
(setter) as ofSyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxNotation)
and returns the very same value (getter).default void
SyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics
(SyntaxNotation aSyntaxNotation) Sets theSyntaxNotation
for theSyntaxNotation
property.default String
Synopsisable.toSynopsis
(SyntaxNotation aSyntaxNotation) Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootTerm
and the childTerm
s, the methodTerm.toSyntax(CliContext)
is called from inside aTerm
hierarchy.default String
Synopsisable.toSynopsis
(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode) Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootTerm
and the childTerm
s, the methodTerm.toSyntax(CliContext)
is called from inside aTerm
hierarchy.default String
Term.toSyntax
(SyntaxNotation aSyntaxNotation) This method is to be called from inside theTerm
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootTerm
.default String
Term.toSyntax
(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode) This method is to be called from inside theTerm
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootTerm
.ArgsParser.withSyntaxMetrics
(SyntaxNotation aSyntaxNotation) Sets theSyntaxNotation
for theSyntaxNotation
property.default B
SyntaxMetricsAccessor.SyntaxMetricsBuilder.withSyntaxMetrics
(SyntaxNotation aSyntaxNotation) Sets theSyntaxNotation
for theSyntaxNotation
property.