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.

Methods in org.refcodes.cli that return types with arguments of type Example

Modifier and Type	Method	Description
List<Example>	ArgsParser.getExamples()	Retrieves the Example instances as added using ArgsParser.addExample(String, Operand...).
List<Example>	ArgsParserImpl.getExamples()	Retrieves the Example instances as added using ArgsParser.addExample(String, Operand...).

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

Modifier and Type	Method	Description
void	ArgsParser.addExample(Example aExample)	Adds a usage example by providing a description of the example and the command line arguments required by the example.
void	ArgsParserImpl.addExample(Example aExampleUsage)	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 ArgsParser	ArgsParser.withExample(Example aExample)	Adds a usage example.
default ArgsParser	ArgsParser.withExamples(Example[] aExamples)	Adds all the bunch of Example elements provided.

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

Modifier and Type	Method	Description
default ArgsParser	ArgsParser.withExamples(Collection<Example> aExamples)	Adds all the bunch of Example elements provided.