com.sampullara.cli

Class Args

java.lang.Object

com.sampullara.cli.Args

public class Args
extends java.lang.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
private static java.util.List<Args.ValueCreator>	DEFAULT_VALUE_CREATORS
static Args.ValueCreator	ENUM_CREATOR
static Args.ValueCreator	FROM_STRING_CONSTRUCTOR Args.ValueCreator building object using a one arg constructor taking a String object as parameter
private static java.util.List<Args.ValueCreator>	valueCreators

Constructor Summary

Constructors

Constructor and Description
Args()

Method Summary

Modifier and Type	Method and Description
private static void	addArgument(java.lang.Class type, java.lang.reflect.Field field, java.lang.Object target, java.lang.Object value, java.lang.String delimiter)
private static void	addPropertyArgument(java.lang.Class type, java.beans.PropertyDescriptor property, java.lang.Object target, java.lang.Object value, java.lang.String delimiter)
static Args.ValueCreator	byStaticMethodInvocation(java.lang.Class<?> compatibleType, java.lang.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
private static java.lang.Object	consumeArgumentValue(java.lang.Class<?> type, Argument argument, java.util.Iterator<java.lang.String> i)
private static java.lang.Object	createValue(java.lang.Class<?> type, java.lang.String valueAsString)
private static void	fieldUsage(java.io.PrintStream errStream, java.lang.Object target, java.lang.reflect.Field field)
(package private) static java.lang.String	getAlias(Argument argument)
(package private) static java.lang.String	getName(Argument argument, java.lang.reflect.Field field)
(package private) static java.lang.String	getName(Argument argument, java.beans.PropertyDescriptor property)
private static java.lang.String	getTypeName(java.lang.Class<?> type)
private static java.lang.Object	getValue(java.lang.Class<?> type, java.lang.Object value, java.lang.String delimiter)
private static void	makeAccessible(java.lang.reflect.AccessibleObject ao)
static java.util.List<java.lang.String>	parse(java.lang.Object target, java.lang.String[] args)
static java.util.List<java.lang.String>	parse(java.lang.Object target, java.lang.String[] args, boolean failOnExtraFlags) Parse a set of arguments and populate the target with the appropriate values.
static java.util.List<java.lang.String>	parseOrExit(java.lang.Object target, java.lang.String[] args) A convenience method for parsing and automatically producing error messages.
private static void	processField(java.lang.Object target, java.lang.reflect.Field field, java.util.List<java.lang.String> arguments)
private static void	processProperty(java.lang.Object target, java.beans.PropertyDescriptor property, java.util.List<java.lang.String> arguments)
private static void	propertyUsage(java.io.PrintStream errStream, java.lang.Object target, java.beans.PropertyDescriptor field)
private static void	propertyUsage(java.io.PrintStream errStream, java.lang.String prefix, java.lang.String name, java.lang.String alias, java.lang.Class<?> type, java.lang.String delimiter, java.lang.String description, java.lang.Object defaultValue)
static void	registerValueCreator(Args.ValueCreator vc) Allows external extension of the valiue creators.
static void	resetValueCreators() Cleanup of registered ValueCreators (mainly for tests)
(package private) static void	setField(java.lang.Class<?> type, java.lang.reflect.Field field, java.lang.Object target, java.lang.Object value, java.lang.String delimiter)
(package private) static void	setProperty(java.lang.Class<?> type, java.beans.PropertyDescriptor property, java.lang.Object target, java.lang.Object value, java.lang.String delimiter)
static void	usage(java.lang.Object target) Generate usage information based on the target annotations.
static void	usage(java.io.PrintStream errStream, java.lang.Object target) 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

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

DEFAULT_VALUE_CREATORS

private static final java.util.List<Args.ValueCreator> DEFAULT_VALUE_CREATORS

valueCreators

private static java.util.List<Args.ValueCreator> valueCreators

Constructor Detail

Args

public Args()

Method Detail

parseOrExit

public static java.util.List<java.lang.String> parseOrExit(java.lang.Object target,
                                                           java.lang.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 java.util.List<java.lang.String> parse(java.lang.Object target,
                                                     java.lang.String[] args)

parse

public static java.util.List<java.lang.String> parse(java.lang.Object target,
                                                     java.lang.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

processField

private static void processField(java.lang.Object target,
                                 java.lang.reflect.Field field,
                                 java.util.List<java.lang.String> arguments)

addArgument

private static void addArgument(java.lang.Class type,
                                java.lang.reflect.Field field,
                                java.lang.Object target,
                                java.lang.Object value,
                                java.lang.String delimiter)

addPropertyArgument

private static void addPropertyArgument(java.lang.Class type,
                                        java.beans.PropertyDescriptor property,
                                        java.lang.Object target,
                                        java.lang.Object value,
                                        java.lang.String delimiter)

processProperty

private static void processProperty(java.lang.Object target,
                                    java.beans.PropertyDescriptor property,
                                    java.util.List<java.lang.String> arguments)

usage

public static void usage(java.lang.Object target)

Generate usage information based on the target annotations.

Parameters:

target - An instance or class.

usage

public static void usage(java.io.PrintStream errStream,
                         java.lang.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.

fieldUsage

private static void fieldUsage(java.io.PrintStream errStream,
                               java.lang.Object target,
                               java.lang.reflect.Field field)

propertyUsage

private static void propertyUsage(java.io.PrintStream errStream,
                                  java.lang.Object target,
                                  java.beans.PropertyDescriptor field)

propertyUsage

private static void propertyUsage(java.io.PrintStream errStream,
                                  java.lang.String prefix,
                                  java.lang.String name,
                                  java.lang.String alias,
                                  java.lang.Class<?> type,
                                  java.lang.String delimiter,
                                  java.lang.String description,
                                  java.lang.Object defaultValue)

getTypeName

private static java.lang.String getTypeName(java.lang.Class<?> type)

getName

static java.lang.String getName(Argument argument,
                                java.beans.PropertyDescriptor property)

consumeArgumentValue

private static java.lang.Object consumeArgumentValue(java.lang.Class<?> type,
                                                     Argument argument,
                                                     java.util.Iterator<java.lang.String> i)

setProperty

static void setProperty(java.lang.Class<?> type,
                        java.beans.PropertyDescriptor property,
                        java.lang.Object target,
                        java.lang.Object value,
                        java.lang.String delimiter)

getAlias

static java.lang.String getAlias(Argument argument)

getName

static java.lang.String getName(Argument argument,
                                java.lang.reflect.Field field)

setField

static void setField(java.lang.Class<?> type,
                     java.lang.reflect.Field field,
                     java.lang.Object target,
                     java.lang.Object value,
                     java.lang.String delimiter)

getValue

private static java.lang.Object getValue(java.lang.Class<?> type,
                                         java.lang.Object value,
                                         java.lang.String delimiter)
                                  throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

createValue

private static java.lang.Object createValue(java.lang.Class<?> type,
                                            java.lang.String valueAsString)
                                     throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

makeAccessible

private static void makeAccessible(java.lang.reflect.AccessibleObject ao)

byStaticMethodInvocation

public static Args.ValueCreator byStaticMethodInvocation(java.lang.Class<?> compatibleType,
                                                         java.lang.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)