Uses of Class
org.refcodes.cli.Example

Uses of Example in org.refcodes.cli

Methods in org.refcodes.cli that return Example

Modifier and Type	Method	Description
static Example	CliSugar.example(String aDescription, Operand<?>... aOperands)	Sugar for creating an Example from a description and the according Operand elements.
static Example[]	CliSugar.examples(Example... aExamples)	Sugar for creating an Example array from a varargs argument.
Example[]	ArgsParser.getExamples()	Retrieves the Example instances from the Example instances property.
Example[]	ExamplesAccessor.getExamples()	Retrieves the Example instances from the Example instances property.
Example[]	ParseArgs.getExamples()	Retrieves the Example instances from the Example instances property.
default Example[]	ExamplesAccessor.ExamplesProperty.letExamples(Example[] aExamples)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given Condition (setter) as of ExamplesAccessor.ExamplesMutator.setExamples(Example[]) and returns the very same value (getter).

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

Modifier and Type	Method	Description
void	ArgsParser.addExample(Example aExampleUsage)	Adds a usage example by providing a description of the example and the command line arguments required by the example.
void	ParseArgs.addExample(Example aExample)	Adds a usage example by providing a description of the example and the command line arguments required by the example.
static Example[]	CliSugar.examples(Example... aExamples)	Sugar for creating an Example array from a varargs argument.
default Example[]	ExamplesAccessor.ExamplesProperty.letExamples(Example[] aExamples)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given Condition (setter) as of ExamplesAccessor.ExamplesMutator.setExamples(Example[]) and returns the very same value (getter).
void	ArgsParser.setExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
void	ExamplesAccessor.ExamplesMutator.setExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
ArgsParser	ArgsParser.withAddExample(Example aExamples)	Builder method adding an application's Example element.
B	ArgsProcessorBuilder.withAddExample(Example aExamples)	Builder method adding an application's Example element.
default ParseArgs	ParseArgs.withAddExample(Example aExample)	Builder method adding an application's Example element.
ArgsParser	ArgsParser.withExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
B	ExamplesAccessor.ExamplesBuilder.withExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.
default ParseArgs	ParseArgs.withExamples(Example[] aExamples)	Sets the Example instances for the Example instances property.

Method parameters in org.refcodes.cli with type arguments of type Example

Modifier and Type	Method	Description
default void	ExamplesAccessor.ExamplesMutator.setExamples(Collection<Example> aExamples)	Sets the Example instances for the Example instances property.
ArgsParser	ArgsParser.withExamples(Collection<Example> aExamples)	Builder method providing the application's Example elements.
default B	ExamplesAccessor.ExamplesBuilder.withExamples(Collection<Example> aExamples)	Builder method providing the application's Example elements.
default ParseArgs	ParseArgs.withExamples(Collection<Example> aExamples)	Builder method providing the application's Example elements.