com.sampullara.cli

Class Args

java.lang.Object

com.sampullara.cli.Args

public class Args
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Args.ValueCreator

Field Summary

Fields

Modifier and Type	Field and Description
static Args.ValueCreator	ENUM_CREATOR
static int	EX_USAGE
static Args.ValueCreator	FROM_STRING_CONSTRUCTOR Args.ValueCreator building object using a one arg constructor taking a String object as parameter

Constructor Summary

Constructors

Constructor and Description
Args()

Method Summary

Modifier and Type	Method and Description
static Args.ValueCreator	byStaticMethodInvocation(Class<?> compatibleType, String methodName) Creates a Args.ValueCreator object able to create object assignable from given type, using a static one arg method which name is the the given one taking a String object as parameter
static List<String>	parse(Object target, String[] args)
static List<String>	parse(Object target, String[] args, boolean failOnExtraFlags) Parse a set of arguments and populate the target with the appropriate values.
static List<String>	parseOrExit(Object target, String[] args) A convenience method for parsing and automatically producing error messages.
static void	registerValueCreator(Args.ValueCreator vc) Allows external extension of the valiue creators.
static void	resetValueCreators() Cleanup of registered ValueCreators (mainly for tests)
static void	usage(Object target) Generate usage information based on the target annotations.
static void	usage(PrintStream errStream, Object target) Generate usage information based on the target annotations.
static void	usage(PrintStream errStream, Object target, Class mainClass) Generate usage information based on the target annotations.

Methods inherited from class java.lang.Object

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

Field Detail

EX_USAGE

public static final int EX_USAGE

See Also:

Constant Field Values

FROM_STRING_CONSTRUCTOR

public static final Args.ValueCreator FROM_STRING_CONSTRUCTOR

Args.ValueCreator building object using a one arg constructor taking a String object as parameter

ENUM_CREATOR

public static final Args.ValueCreator ENUM_CREATOR

Constructor Detail

Args

public Args()

Method Detail

parseOrExit

public static List<String> parseOrExit(Object target,
                                       String[] args)

A convenience method for parsing and automatically producing error messages.

Parameters:

target - Either an instance or a class

args - The arguments you want to parse and populate

Returns:

The list of arguments that were not consumed

parse

public static List<String> parse(Object target,
                                 String[] args)

parse

public static List<String> parse(Object target,
                                 String[] args,
                                 boolean failOnExtraFlags)

Parse a set of arguments and populate the target with the appropriate values.

Parameters:

target - Either an instance or a class

args - The arguments you want to parse and populate

failOnExtraFlags - Throw an IllegalArgumentException if extra flags are present

Returns:

The list of arguments that were not consumed

usage

public static void usage(Object target)

Generate usage information based on the target annotations.

Parameters:

target - An instance or class.

usage

public static void usage(PrintStream errStream,
                         Object target)

Generate usage information based on the target annotations.

Parameters:

errStream - A PrintStream to print the usage information to.

target - An instance or class.

usage

public static void usage(PrintStream errStream,
                         Object target,
                         Class mainClass)

Generate usage information based on the target annotations.

Parameters:

errStream - A PrintStream to print the usage information to.

target - An instance or class.

mainClass - The class containing the main method

byStaticMethodInvocation

public static Args.ValueCreator byStaticMethodInvocation(Class<?> compatibleType,
                                                         String methodName)

Creates a Args.ValueCreator object able to create object assignable from given type, using a static one arg method which name is the the given one taking a String object as parameter

Parameters:

compatibleType - the base assignable for which this object will try to invoke the given method

methodName - the name of the one arg method taking a String as parameter that will be used to built a new value

Returns:

null if the object could not be created, the value otherwise

registerValueCreator

public static void registerValueCreator(Args.ValueCreator vc)

Allows external extension of the valiue creators.

Parameters:

vc - another value creator to take into account for trying to create values

resetValueCreators

public static void resetValueCreators()

Cleanup of registered ValueCreators (mainly for tests)