Uses of Interface
org.refcodes.cli.SyntaxMetrics
-
Uses of SyntaxMetrics in org.refcodes.cli
Modifier and TypeClassDescriptionclass
TheSyntaxMetricsImpl
class implements theSyntaxMetrics
interface for building customSyntaxMetrics
instances.enum
TheSyntaxNotation
is used by a theTerm.toSyntax(CliContext)
method to determine which notation to be used for the generated syntax.Modifier and TypeMethodDescriptionSyntaxMetricsImpl.Builder.build()
SyntaxMetricsImpl.Builder
for fluently building aSyntaxMetrics
instances.ArgsParser.getSyntaxMetrics()
Retrieves theSyntaxMetrics
from theSyntaxMetrics
property.CliContext.getSyntaxMetrics()
Retrieves theSyntaxMetrics
from theSyntaxMetrics
property.SyntaxMetricsAccessor.getSyntaxMetrics()
Retrieves theSyntaxMetrics
from theSyntaxMetrics
property.default SyntaxMetrics
SyntaxMetricsAccessor.SyntaxMetricsProperty.letSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenSyntaxMetrics
(setter) as ofSyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxMetrics)
and returns the very same value (getter).Modifier and TypeMethodDescriptiondefault SyntaxMetrics
SyntaxMetricsAccessor.SyntaxMetricsProperty.letSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) This method stores and passes through the given argument, which is very useful for builder APIs: Sets the givenSyntaxMetrics
(setter) as ofSyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxMetrics)
and returns the very same value (getter).void
ArgsParser.setSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.void
ParseArgs.setSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.void
SyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.ArgsParser.withSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.CliContext.Builder.withSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.default ParseArgs
ParseArgs.withSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.SyntaxMetricsAccessor.SyntaxMetricsBuilder.withSyntaxMetrics
(SyntaxMetrics aSyntaxMetrics) Sets theSyntaxMetrics
for theSyntaxMetrics
property.ModifierConstructorDescriptionCliContext
(CliMetrics aCliMetrics, SyntaxMetrics aSyntaxMetrics) Constructs an accordingly configuredCliContext
instance.CliContext
(SyntaxMetrics aSyntaxMetrics) Constructs an accordingly configuredCliContext
instance.CliContext
(SyntaxMetrics aSyntaxMetrics, boolean isEscapeCodesEnabled) Constructs an accordingly configuredCliContext
instance.CliContext
(SyntaxMetrics aSyntaxMetrics, Character aShortOptionPrefix, String aLongOptionPrefix, boolean isEscapeCodesEnabled, String aArgumentEscapeCode, String aOptionEscapeCode, String aResetEscapeCode) Constructs an accordingly configuredCliContext
instance.CliContext
(SyntaxMetrics aSyntaxMetrics, String aArgumentEscapeCode, String aOptionEscapeCode, String aResetEscapeCode) Constructs an accordingly configuredCliContext
instance.