public class ParameterDescription
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
(package private) class |
ParameterDescription.SubParameterIndex |
Modifier and Type | Field and Description |
---|---|
private boolean |
assigned
Keep track of whether a value was added to flag an error
|
private java.util.ResourceBundle |
bundle |
private java.lang.Object |
defaultObject |
private java.lang.String |
description |
private DynamicParameter |
dynamicParameterAnnotation |
private JCommander |
jCommander |
private java.lang.String |
longestName
Longest of the names(), used to present usage() alphabetically
|
private java.lang.Object |
object |
private Parameter |
parameterAnnotation |
private Parameterized |
parameterized
The field/method
|
private WrappedParameter |
wrappedParameter |
Constructor and Description |
---|
ParameterDescription(java.lang.Object object,
DynamicParameter annotation,
Parameterized parameterized,
java.util.ResourceBundle bundle,
JCommander jc) |
ParameterDescription(java.lang.Object object,
Parameter annotation,
Parameterized parameterized,
java.util.ResourceBundle bundle,
JCommander jc) |
Modifier and Type | Method and Description |
---|---|
void |
addValue(java.lang.String value) |
void |
addValue(java.lang.String value,
boolean isDefault)
Add the specified value to the field.
|
(package private) java.lang.Object |
addValue(java.lang.String name,
java.lang.String value,
boolean isDefault,
boolean validate,
int currentIndex) |
private boolean |
fieldIsSetForTheFirstTime(boolean isDefault) |
private java.util.ResourceBundle |
findResourceBundle(java.lang.Object o)
Find the resource bundle in the annotations.
|
private java.util.List<ParameterDescription.SubParameterIndex> |
findSubParameters(java.lang.Class<?> type) |
java.lang.Object |
getDefault() |
java.lang.String |
getDescription() |
java.lang.String |
getLongestName() |
java.lang.String |
getNames() |
java.lang.Object |
getObject() |
WrappedParameter |
getParameter() |
Parameter |
getParameterAnnotation() |
Parameterized |
getParameterized() |
private java.lang.Object |
handleSubParameters(java.lang.String value,
int currentIndex,
java.lang.Class<?> type,
java.util.List<ParameterDescription.SubParameterIndex> subParameters) |
private void |
init(java.lang.Object object,
Parameterized parameterized,
java.util.ResourceBundle bundle,
JCommander jCommander)
Initializes the state of this parameter description.
|
private void |
initDescription(java.lang.String description,
java.lang.String descriptionKey,
java.lang.String[] names) |
boolean |
isAssigned() |
boolean |
isDynamicParameter() |
private boolean |
isEmpty(java.lang.String s) |
boolean |
isHelp() |
private boolean |
isMultiOption() |
boolean |
isNonOverwritableForced() |
private java.util.Collection<java.lang.Object> |
newCollection(java.lang.Class<?> type) |
private void |
p(java.lang.String string) |
void |
setAssigned(boolean b) |
java.lang.String |
toString() |
private void |
validateDefaultValues(java.lang.String[] names) |
void |
validateParameter(java.lang.Class<? extends IParameterValidator> validator,
java.lang.String name,
java.lang.String value) |
private void |
validateParameter(java.lang.String name,
java.lang.String value) |
void |
validateValueParameter(java.lang.Class<? extends IValueValidator> validator,
java.lang.String name,
java.lang.Object value) |
(package private) void |
validateValueParameter(java.lang.String name,
java.lang.Object value) |
private java.lang.Object object
private WrappedParameter wrappedParameter
private Parameter parameterAnnotation
private DynamicParameter dynamicParameterAnnotation
private Parameterized parameterized
private boolean assigned
private java.util.ResourceBundle bundle
private java.lang.String description
private JCommander jCommander
private java.lang.Object defaultObject
private java.lang.String longestName
public ParameterDescription(java.lang.Object object, DynamicParameter annotation, Parameterized parameterized, java.util.ResourceBundle bundle, JCommander jc)
public ParameterDescription(java.lang.Object object, Parameter annotation, Parameterized parameterized, java.util.ResourceBundle bundle, JCommander jc)
private java.util.ResourceBundle findResourceBundle(java.lang.Object o)
private boolean isEmpty(java.lang.String s)
private void initDescription(java.lang.String description, java.lang.String descriptionKey, java.lang.String[] names)
private void init(java.lang.Object object, Parameterized parameterized, java.util.ResourceBundle bundle, JCommander jCommander)
object
- the object defining the command-line argumentsparameterized
- the wrapper for the field or method annotated with \@Parameter this representsbundle
- the localejCommander
- the parent JCommander instanceinitDescription(String, String, String[])
private void validateDefaultValues(java.lang.String[] names)
public java.lang.String getLongestName()
public java.lang.Object getDefault()
public java.lang.String getDescription()
public java.lang.Object getObject()
public java.lang.String getNames()
public WrappedParameter getParameter()
public Parameterized getParameterized()
private boolean isMultiOption()
public void addValue(java.lang.String value)
public boolean isAssigned()
public void setAssigned(boolean b)
public void addValue(java.lang.String value, boolean isDefault)
java.lang.Object addValue(java.lang.String name, java.lang.String value, boolean isDefault, boolean validate, int currentIndex)
private java.lang.Object handleSubParameters(java.lang.String value, int currentIndex, java.lang.Class<?> type, java.util.List<ParameterDescription.SubParameterIndex> subParameters)
public Parameter getParameterAnnotation()
private java.util.List<ParameterDescription.SubParameterIndex> findSubParameters(java.lang.Class<?> type)
private void validateParameter(java.lang.String name, java.lang.String value)
void validateValueParameter(java.lang.String name, java.lang.Object value)
public void validateValueParameter(java.lang.Class<? extends IValueValidator> validator, java.lang.String name, java.lang.Object value)
public void validateParameter(java.lang.Class<? extends IParameterValidator> validator, java.lang.String name, java.lang.String value)
private java.util.Collection<java.lang.Object> newCollection(java.lang.Class<?> type)
private boolean fieldIsSetForTheFirstTime(boolean isDefault)
private void p(java.lang.String string)
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isDynamicParameter()
public boolean isHelp()
public boolean isNonOverwritableForced()