org.cyclopsgroup.jcli

Class ArgumentProcessor<T>

java.lang.Object

org.cyclopsgroup.jcli.ArgumentProcessor<T>

Type Parameters:

T - Type of bean it processes.

public abstract class ArgumentProcessor<T>
extends Object

The facade class that parses arguments and sets values to given bean

Author:

Jiaqi Guo

Constructor Summary

Constructors

Constructor and Description
ArgumentProcessor()

Method Summary

Modifier and Type	Method and Description
abstract ParsingContext	createParsingContext()
static <T> ArgumentProcessor<T>	forType(Class<T> beanType) Create new instance with default parser, a GnuParser
static <T> ArgumentProcessor<T>	forTypeOf(T bean)
static <T> ArgumentProcessor<T>	newInstance(Class<? extends T> beanType, CommandLineParser parser) Create new instance with given bean type and command line parser that describes command line sytnax.
static <T> ArgumentProcessor<T>	newInstance(Class<T> beanType) Deprecated. Use forType(Class) instead.
abstract void	printHelp(PrintWriter out)
abstract void	process(List<String> arguments, T bean) Process argument list and pass values to given bean
void	process(String[] arguments, T bean) Process argument array and pass values to given bean
abstract ValidationResult	validate(String[] arguments) Verifies if given arguments meet requirement defined for processor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentProcessor

public ArgumentProcessor()

Method Detail

forType

public static <T> ArgumentProcessor<T> forType(Class<T> beanType)

Create new instance with default parser, a GnuParser

Type Parameters:

T - Type of the bean

Parameters:

beanType - Type of the bean

Returns:

Instance of an implementation of argument processor

forTypeOf

public static <T> ArgumentProcessor<T> forTypeOf(T bean)

newInstance

public static <T> ArgumentProcessor<T> newInstance(Class<? extends T> beanType,
                                                   CommandLineParser parser)

Create new instance with given bean type and command line parser that describes command line sytnax.

Type Parameters:

T - type of bean

Parameters:

beanType - Type of bean

parser - command line parser that is aware of command line syntax

Returns:

instance of an implementation of argument processor.

newInstance

public static <T> ArgumentProcessor<T> newInstance(Class<T> beanType)

Deprecated. Use forType(Class) instead.

Type Parameters:

T - type of bean class.

Parameters:

beanType - type of the bean.

Returns:

instance of argument processor for given type of bean.

createParsingContext

public abstract ParsingContext createParsingContext()

Returns:

Implementation of parsing context

printHelp

public abstract void printHelp(PrintWriter out)
                        throws IOException

Parameters:

out - Output to print help message to

Throws:

IOException - Allows IO errors

process

public abstract void process(List<String> arguments,
                             T bean)

Process argument list and pass values to given bean

Parameters:

arguments - List of arguments

bean - Bean to pass values to

process

public void process(String[] arguments,
                    T bean)

Process argument array and pass values to given bean

Parameters:

arguments - Arary of arguments

bean - Bean to pass values to

validate

public abstract ValidationResult validate(String[] arguments)

Verifies if given arguments meet requirement defined for processor.

Parameters:

arguments - array of command line arguments.

Returns:

a result object.