Uses of Interface
org.refcodes.cli.SyntaxMetrics

Uses of SyntaxMetrics in org.refcodes.cli

Classes in org.refcodes.cli that implement SyntaxMetrics

Modifier and Type	Class	Description
class	SyntaxMetricsImpl	The SyntaxMetricsImpl class implements the SyntaxMetrics interface for building custom SyntaxMetrics instances.
enum	SyntaxNotation	The SyntaxNotation is used by a the Constituent.toSyntax(CliContext) method to determine which notation to be used for the generated syntax.

Methods in org.refcodes.cli that return SyntaxMetrics

Modifier and Type	Method	Description
SyntaxMetrics	SyntaxMetricsImpl.Builder.build()	SyntaxMetricsImpl.Builder for fluently building a SyntaxMetrics instances.
SyntaxMetrics	ArgsParserImpl.getSyntaxMetrics()	Retrieves the SyntaxMetrics from the SyntaxMetrics property.
SyntaxMetrics	CliContext.getSyntaxMetrics()	Retrieves the SyntaxMetrics from the SyntaxMetrics property.
SyntaxMetrics	SyntaxMetricsAccessor.getSyntaxMetrics()	Retrieves the SyntaxMetrics from the SyntaxMetrics 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 given SyntaxMetrics (setter) as of SyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxMetrics) and returns the very same value (getter).

Methods in org.refcodes.cli with parameters of type SyntaxMetrics

Modifier and Type	Method	Description
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 given SyntaxMetrics (setter) as of SyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxMetrics) and returns the very same value (getter).
void	ArgsParser.setSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Set the SyntaxNotation.
void	ArgsParserImpl.setSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Set the SyntaxNotation.
void	SyntaxMetricsAccessor.SyntaxMetricsMutator.setSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.
default ArgsParser	ArgsParser.withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Set the SyntaxNotation and make other adjustments with the result (with regards to the Builder-Pattern).
CliContext.Builder	CliContext.Builder.withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.
B	SyntaxMetricsAccessor.SyntaxMetricsBuilder.withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.

Constructors in org.refcodes.cli with parameters of type SyntaxMetrics

Modifier	Constructor	Description
	CliContext(CliMetrics aCliMetrics, SyntaxMetrics aSyntaxMetrics)	Constructs an accordingly configured CliContext instance.
	CliContext(SyntaxMetrics aSyntaxMetrics)	Constructs an accordingly configured CliContext instance.
	CliContext(SyntaxMetrics aSyntaxMetrics, boolean isEscapeCodesEnabled)	Constructs an accordingly configured CliContext instance.
	CliContext(SyntaxMetrics aSyntaxMetrics, Character aShortOptionPrefix, String aLongOptionPrefix, boolean isEscapeCodesEnabled, String aArgumentEscapeCode, String aOptionEscapeCode, String aResetEscapeCode)	Constructs an accordingly configured CliContext instance.
	CliContext(SyntaxMetrics aSyntaxMetrics, String aArgumentEscapeCode, String aOptionEscapeCode, String aResetEscapeCode)	Constructs an accordingly configured CliContext instance.