com.lexicalscope.jewel.cli

Class CliFactory

java.lang.Object

com.lexicalscope.jewel.cli.CliFactory

public abstract class CliFactory
extends Object

Constructs a Cli from an annotated interface definition.

Author:

Tim Wood

See Also:

Option

Constructor Summary

Constructors

Constructor and Description
CliFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static <O> Cli<O>	createCli(Class<O> klass) Construct a Cli from an annotated interface definition
static <O> Cli<O>	createCliUsingInstance(O options) Construct a Cli from an annotated class
static <O> O	parseArguments(Class<O> klass, String... arguments) Parse arguments from an annotated interface definition
static <O> O	parseArgumentsUsingInstance(O options, String... arguments) Parse arguments from an annotated class instance

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CliFactory

public CliFactory()

Method Detail

createCli

public static <O> Cli<O> createCli(Class<O> klass)
                        throws InvalidOptionSpecificationException

Construct a Cli from an annotated interface definition

Type Parameters:

O - The type of the interface that will be used to present the arguments

Parameters:

klass - The annotated interface definition

Returns:

A Cli configured to create instance of klass

Throws:

ArgumentValidationException - the arguments do not meet the CLI specification

InvalidOptionSpecificationException - the CLI specification is not valid

createCliUsingInstance

public static <O> Cli<O> createCliUsingInstance(O options)
                                     throws InvalidOptionSpecificationException

Construct a Cli from an annotated class

Type Parameters:

O - The type of the class used to present the arguments

Parameters:

options - The annotated class

Returns:

A Cli configured to configure the options

Throws:

ArgumentValidationException - the arguments do not meet the CLI specification

InvalidOptionSpecificationException - the CLI specification is not valid

parseArguments

public static <O> O parseArguments(Class<O> klass,
                   String... arguments)
                        throws ArgumentValidationException,
                               InvalidOptionSpecificationException

Parse arguments from an annotated interface definition

Type Parameters:

O - The type of the interface that will be used to present the arguments

Parameters:

klass - The annotated interface definition

arguments -

Returns:

The parsed arguments

Throws:

ArgumentValidationException - the arguments do not meet the CLI specification

InvalidOptionSpecificationException - the CLI specification is not valid

parseArgumentsUsingInstance

public static <O> O parseArgumentsUsingInstance(O options,
                                String... arguments)
                                     throws ArgumentValidationException,
                                            InvalidOptionSpecificationException

Parse arguments from an annotated class instance

Type Parameters:

O - The type of the class used to present the arguments

Parameters:

klass - The annotated interface definition

arguments -

Returns:

The parsed arguments

Throws:

ArgumentValidationException - the arguments do not meet the CLI specification

InvalidOptionSpecificationException - the CLI specification is not valid