jcommander 1.82 · com.beust.jcommander.Parameterized

Modifier and Type	Field and Description
private Field	field
private Method	getter
private Method	method
private ParametersDelegate	parametersDelegate
private WrappedParameter	wrappedParameter

Access	Constructor and Description
public	Parameterized(WrappedParameter wp, ParametersDelegate pd, Field field, Method method)

Method Summary

Modifier and Type	Method and Description
private static void	describeClassTree(Class<?> the class to analyze inputClass, Set<Class<?>> the set collector to collect the results setOfClasses) Recursive handler for describing the set of classes while using the setOfClasses parameter as a collector
private static Set<Class<?>>	Returns: set of classes that are implemented or extended by that object describeClassTree(Class<?> object to describe inputClass) Given an object return the set of classes that it extends or implements.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private static String	errorMessage(Method m, Exception ex)
public Type	Returns: the generic type of the collection for this field, or null if not applicable. findFieldGenericType()
public Object	get(Object object)
public ParametersDelegate	getDelegateAnnotation()
public Type	getGenericType()
public String	getName()
public Parameter	getParameter()
public Class<?>	getType()
public WrappedParameter	getWrappedParameter()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isDynamicParameter(Field field)
public boolean	isDynamicParameter()
public static List<Parameterized>	parseArg(Object arg)
public void	set(Object object, Object value)
private static void	setFieldAccessible(Field f)
private static void	setFieldAccessibleWithoutFinalCheck(Field f)
private void	setGetter(Object object)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

field	back to summary
private Field field

getter	back to summary
private Method getter

method	back to summary
private Method method

parametersDelegate	back to summary
private ParametersDelegate parametersDelegate

wrappedParameter	back to summary
private WrappedParameter wrappedParameter

Parameterized	back to summary
public Parameterized(WrappedParameter wp, ParametersDelegate pd, Field field, Method method)

Method Detail

describeClassTree	back to summary
private static void describeClassTree(Class<?> inputClass, Set<Class<?>> setOfClasses) Recursive handler for describing the set of classes while using the setOfClasses parameter as a collector Parameters inputClass:Class<?> the class to analyze setOfClasses:Set<Class<?>> the set collector to collect the results

describeClassTree

back to summary

private static void describeClassTree(Class<?> inputClass, Set<Class<?>> setOfClasses)

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

Parameters

inputClass:Class<?>: the class to analyze
setOfClasses:Set<Class<?>>: the set collector to collect the results

describeClassTree	back to summary
private static Set<Class<?>> describeClassTree(Class<?> inputClass) Given an object return the set of classes that it extends or implements. Parameters inputClass:Class<?> object to describe Returns:Set<Class<?>> set of classes that are implemented or extended by that object

describeClassTree

back to summary

private static Set<Class<?>> describeClassTree(Class<?> inputClass)

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

Parameters

inputClass:Class<?>: object to describe

Returns:Set<Class<?>>

set of classes that are implemented or extended by that object

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

errorMessage	back to summary
private static String errorMessage(Method m, Exception ex)

findFieldGenericType	back to summary
public Type findFieldGenericType() Returns:Type the generic type of the collection for this field, or null if not applicable.

get	back to summary
public Object get(Object object)

getDelegateAnnotation	back to summary
public ParametersDelegate getDelegateAnnotation()

getGenericType	back to summary
public Type getGenericType()

getName	back to summary
public String getName()

getParameter	back to summary
public Parameter getParameter()

getType	back to summary
public Class<?> getType()

getWrappedParameter	back to summary
public WrappedParameter getWrappedParameter()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isDynamicParameter	back to summary
public boolean isDynamicParameter(Field field)

isDynamicParameter	back to summary
public boolean isDynamicParameter()

parseArg	back to summary
public static List<Parameterized> parseArg(Object arg)

set	back to summary
public void set(Object object, Object value)

setFieldAccessible	back to summary
private static void setFieldAccessible(Field f)

setFieldAccessibleWithoutFinalCheck	back to summary
private static void setFieldAccessibleWithoutFinalCheck(Field f)

setGetter	back to summary
private void setGetter(Object object) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException

public Class Parameterized

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail