com.beust.jcommander

Class Parameterized

java.lang.Object

com.beust.jcommander.Parameterized

public class Parameterized
extends java.lang.Object

Encapsulate a field or a method annotated with @Parameter or @DynamicParameter

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.reflect.Field	field
private java.lang.reflect.Method	getter
private java.lang.reflect.Method	method
private ParametersDelegate	parametersDelegate
private WrappedParameter	wrappedParameter

Constructor Summary

Constructors

Constructor and Description
Parameterized(WrappedParameter wp, ParametersDelegate pd, java.lang.reflect.Field field, java.lang.reflect.Method method)

Method Summary

Modifier and Type	Method and Description
private static java.util.Set<java.lang.Class<?>>	describeClassTree(java.lang.Class<?> inputClass) Given an object return the set of classes that it extends or implements.
private static void	describeClassTree(java.lang.Class<?> inputClass, java.util.Set<java.lang.Class<?>> setOfClasses) Recursive handler for describing the set of classes while using the setOfClasses parameter as a collector
boolean	equals(java.lang.Object obj)
private static java.lang.String	errorMessage(java.lang.reflect.Method m, java.lang.Exception ex)
java.lang.reflect.Type	findFieldGenericType()
java.lang.Object	get(java.lang.Object object)
ParametersDelegate	getDelegateAnnotation()
java.lang.reflect.Type	getGenericType()
java.lang.String	getName()
Parameter	getParameter()
java.lang.Class<?>	getType()
WrappedParameter	getWrappedParameter()
int	hashCode()
boolean	isDynamicParameter()
boolean	isDynamicParameter(java.lang.reflect.Field field)
static java.util.List<Parameterized>	parseArg(java.lang.Object arg)
void	set(java.lang.Object object, java.lang.Object value)
private static void	setFieldAccessible(java.lang.reflect.Field f)
private static void	setFieldAccessibleWithoutFinalCheck(java.lang.reflect.Field f)
private void	setGetter(java.lang.Object object)

Methods inherited from class java.lang.Object

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

Field Detail

field

private java.lang.reflect.Field field

method

private java.lang.reflect.Method method

getter

private java.lang.reflect.Method getter

wrappedParameter

private WrappedParameter wrappedParameter

parametersDelegate

private ParametersDelegate parametersDelegate

Constructor Detail

Parameterized

public Parameterized(WrappedParameter wp,
                     ParametersDelegate pd,
                     java.lang.reflect.Field field,
                     java.lang.reflect.Method method)

Method Detail

describeClassTree

private static void describeClassTree(java.lang.Class<?> inputClass,
                                      java.util.Set<java.lang.Class<?>> setOfClasses)

Recursive handler for describing the set of classes while using the setOfClasses parameter as a collector

Parameters:

inputClass - the class to analyze

setOfClasses - the set collector to collect the results

describeClassTree

private static java.util.Set<java.lang.Class<?>> describeClassTree(java.lang.Class<?> inputClass)

Given an object return the set of classes that it extends or implements.

Parameters:

inputClass - object to describe

Returns:

set of classes that are implemented or extended by that object

parseArg

public static java.util.List<Parameterized> parseArg(java.lang.Object arg)

getWrappedParameter

public WrappedParameter getWrappedParameter()

getType

public java.lang.Class<?> getType()

getName

public java.lang.String getName()

get

public java.lang.Object get(java.lang.Object object)

setGetter

private void setGetter(java.lang.Object object)
                throws java.lang.IllegalAccessException,
                       java.lang.reflect.InvocationTargetException,
                       java.lang.NoSuchMethodException

Throws:

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isDynamicParameter

public boolean isDynamicParameter(java.lang.reflect.Field field)

setFieldAccessible

private static void setFieldAccessible(java.lang.reflect.Field f)

setFieldAccessibleWithoutFinalCheck

private static void setFieldAccessibleWithoutFinalCheck(java.lang.reflect.Field f)

errorMessage

private static java.lang.String errorMessage(java.lang.reflect.Method m,
                                             java.lang.Exception ex)

set

public void set(java.lang.Object object,
                java.lang.Object value)

getDelegateAnnotation

public ParametersDelegate getDelegateAnnotation()

getGenericType

public java.lang.reflect.Type getGenericType()

getParameter

public Parameter getParameter()

findFieldGenericType

public java.lang.reflect.Type findFieldGenericType()

Returns:

the generic type of the collection for this field, or null if not applicable.

isDynamicParameter

public boolean isDynamicParameter()