jcommander 1.82 · com.beust.jcommander.ParameterDescription

Modifier and Type	Class and Description
pack-priv class	ParameterDescription.SubParameterIndex

Field Summary

Modifier and Type	Field and Description
private boolean	assigned Keep track of whether a value was added to flag an error
private ResourceBundle	bundle
private Object	defaultObject
private String	description
private DynamicParameter	dynamicParameterAnnotation
private JCommander	jCommander
private String	longestName Longest of the names(), used to present usage() alphabetically
private Object	object
private Parameter	parameterAnnotation
private Parameterized	parameterized The field/method
private WrappedParameter	wrappedParameter

Constructor Summary

Access	Constructor and Description
public	ParameterDescription(Object object, DynamicParameter annotation, Parameterized parameterized, ResourceBundle bundle, JCommander jc)
public	ParameterDescription(Object object, Parameter annotation, Parameterized parameterized, ResourceBundle bundle, JCommander jc)

Method Summary

Modifier and Type	Method and Description
public void	addValue(String value)
public void	addValue(String value, boolean isDefault) Add the specified value to the field.
pack-priv Object	addValue(String name, String value, boolean isDefault, boolean validate, int currentIndex)
private boolean	fieldIsSetForTheFirstTime(boolean isDefault)
private ResourceBundle	findResourceBundle(Object o) Find the resource bundle in the annotations.
private List<ParameterDescription.SubParameterIndex>	findSubParameters(Class<?> type)
public Object	getDefault()
public String	getDescription()
public String	getLongestName()
public String	getNames()
public Object	getObject()
public WrappedParameter	getParameter()
public Parameter	getParameterAnnotation()
public Parameterized	getParameterized()
private Object	handleSubParameters(String value, int currentIndex, Class<?> type, List<ParameterDescription.SubParameterIndex> subParameters)
private void	init(Object the object defining the command-line arguments object, Parameterized the wrapper for the field or method annotated with \@Parameter this represents parameterized, ResourceBundle the locale bundle, JCommander the parent JCommander instance jCommander) Initializes the state of this parameter description.
private void	initDescription(String description, String descriptionKey, String[] names)
public boolean	Returns: true if this parameter received a value during the parsing phase. isAssigned()
public boolean	isDynamicParameter()
private boolean	isEmpty(String s)
public boolean	isHelp()
private boolean	isMultiOption()
public boolean	isNonOverwritableForced()
private Collection<Object>	newCollection(Class<?> type)
private void	p(String string)
public void	setAssigned(boolean b)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	validateDefaultValues(String[] names)
private void	validateParameter(String name, String value)
public void	validateParameter(Class<? extends IParameterValidator> validator, String name, String value)
pack-priv void	validateValueParameter(String name, Object value)
public void	validateValueParameter(Class<? extends IValueValidator<T>> validator, String name, Object value)

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

Field Detail

assigned	back to summary
private boolean assigned Keep track of whether a value was added to flag an error

bundle	back to summary
private ResourceBundle bundle

defaultObject	back to summary
private Object defaultObject

description	back to summary
private String description

dynamicParameterAnnotation	back to summary
private DynamicParameter dynamicParameterAnnotation

jCommander	back to summary
private JCommander jCommander

longestName	back to summary
private String longestName Longest of the names(), used to present usage() alphabetically

object	back to summary
private Object object

parameterAnnotation	back to summary
private Parameter parameterAnnotation

parameterized	back to summary
private Parameterized parameterized The field/method

wrappedParameter	back to summary
private WrappedParameter wrappedParameter

Constructor Detail

ParameterDescription	back to summary
public ParameterDescription(Object object, DynamicParameter annotation, Parameterized parameterized, ResourceBundle bundle, JCommander jc)

ParameterDescription	back to summary
public ParameterDescription(Object object, Parameter annotation, Parameterized parameterized, ResourceBundle bundle, JCommander jc)

Method Detail

addValue	back to summary
public void addValue(String value)

addValue	back to summary
public void addValue(String value, boolean isDefault) Add the specified value to the field. First, validate the value if a validator was specified. Then look up any field converter, then any type converter, and if we can't find any, throw an exception.

addValue	back to summary
pack-priv Object addValue(String name, String value, boolean isDefault, boolean validate, int currentIndex)

fieldIsSetForTheFirstTime	back to summary
private boolean fieldIsSetForTheFirstTime(boolean isDefault)

findResourceBundle	back to summary
private ResourceBundle findResourceBundle(Object o) Find the resource bundle in the annotations. Annotations @SuppressWarnings:deprecation

findResourceBundle

back to summary

private ResourceBundle findResourceBundle(Object o)

Find the resource bundle in the annotations.

Annotations

@SuppressWarnings:deprecation

findSubParameters	back to summary
private List<ParameterDescription.SubParameterIndex> findSubParameters(Class<?> type)

getDefault	back to summary
public Object getDefault()

getDescription	back to summary
public String getDescription()

getLongestName	back to summary
public String getLongestName()

getNames	back to summary
public String getNames()

getObject	back to summary
public Object getObject()

getParameter	back to summary
public WrappedParameter getParameter()

getParameterAnnotation	back to summary
public Parameter getParameterAnnotation()

getParameterized	back to summary
public Parameterized getParameterized()

handleSubParameters	back to summary
private Object handleSubParameters(String value, int currentIndex, Class<?> type, List<ParameterDescription.SubParameterIndex> subParameters)

init back to summary

init	back to summary
private void init(Object object, Parameterized parameterized, ResourceBundle bundle, JCommander jCommander) Initializes the state of this parameter description. This will set an appropriate bundle if it is null<. If its the description in is empty and it refers to an enum type, then the description will be set to its possible values. It will also attempt to validate the default value of the parameter. Parameters object:Object the object defining the command-line arguments parameterized:Parameterized the wrapper for the field or method annotated with \@Parameter this represents bundle:ResourceBundle the locale jCommander:JCommander the parent JCommander instance Annotations @SuppressWarnings:unchecked See Also `initDescription(String, String, String[])`

private void init(Object object, Parameterized parameterized, ResourceBundle bundle, JCommander jCommander)

Initializes the state of this parameter description. This will set an appropriate bundle if it is null<. If its the description in is empty and it refers to an enum type, then the description will be set to its possible values. It will also attempt to validate the default value of the parameter.

Parameters

object:Object: the object defining the command-line arguments
parameterized:Parameterized: the wrapper for the field or method annotated with \@Parameter this represents
bundle:ResourceBundle: the locale
jCommander:JCommander: the parent JCommander instance

Annotations

@SuppressWarnings:unchecked

initDescription	back to summary
private void initDescription(String description, String descriptionKey, String[] names)

isAssigned	back to summary
public boolean isAssigned() Returns:boolean true if this parameter received a value during the parsing phase.

isDynamicParameter	back to summary
public boolean isDynamicParameter()

isEmpty	back to summary
private boolean isEmpty(String s)

isHelp	back to summary
public boolean isHelp()

isMultiOption	back to summary
private boolean isMultiOption()

isNonOverwritableForced	back to summary
public boolean isNonOverwritableForced()

newCollection	back to summary
private Collection<Object> newCollection(Class<?> type) Annotations @SuppressWarnings:unchecked

p	back to summary
private void p(String string)

setAssigned	back to summary
public void setAssigned(boolean b)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

validateDefaultValues	back to summary
private void validateDefaultValues(String[] names)

validateParameter	back to summary
private void validateParameter(String name, String value)

validateParameter	back to summary
public void validateParameter(Class<? extends IParameterValidator> validator, String name, String value)

validateValueParameter	back to summary
pack-priv void validateValueParameter(String name, Object value)

validateValueParameter	back to summary
public void validateValueParameter(Class<? extends IValueValidator<T>> validator, String name, Object value)

public Class ParameterDescription

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ParameterDescription.SubParameterIndex

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail