Package com.beust.jcommander
Class ParameterDescription
java.lang.Object
com.beust.jcommander.ParameterDescription
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Keep track of whether a value was added to flag an errorprivate ResourceBundle
private Object
private String
private DynamicParameter
private JCommander
private String
Longest of the names(), used to present usage() alphabeticallyprivate Object
private Parameter
private Parameterized
The field/methodprivate WrappedParameter
-
Constructor Summary
ConstructorsConstructorDescriptionParameterDescription
(Object object, DynamicParameter annotation, Parameterized parameterized, ResourceBundle bundle, JCommander jc) ParameterDescription
(Object object, Parameter annotation, Parameterized parameterized, ResourceBundle bundle, JCommander jc) -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
Add the specified value to the field.(package private) Object
private boolean
fieldIsSetForTheFirstTime
(boolean isDefault) private ResourceBundle
Find the resource bundle in the annotations.findSubParameters
(Class<?> type) getNames()
private Object
handleSubParameters
(String value, int currentIndex, Class<?> type, List<ParameterDescription.SubParameterIndex> subParameters) private void
init
(Object object, Parameterized parameterized, ResourceBundle bundle, JCommander jCommander) Initializes the state of this parameter description.private void
initDescription
(String description, String descriptionKey, String[] names) boolean
boolean
private boolean
boolean
isHelp()
private boolean
boolean
private Collection<Object>
newCollection
(Class<?> type) private void
void
setAssigned
(boolean b) toString()
private void
validateDefaultValues
(String[] names) void
validateParameter
(Class<? extends IParameterValidator> validator, String name, String value) private void
validateParameter
(String name, String value) void
validateValueParameter
(Class<? extends IValueValidator> validator, String name, Object value) (package private) void
validateValueParameter
(String name, Object value)
-
Field Details
-
object
-
wrappedParameter
-
parameterAnnotation
-
dynamicParameterAnnotation
-
parameterized
The field/method -
assigned
private boolean assignedKeep track of whether a value was added to flag an error -
bundle
-
description
-
jCommander
-
defaultObject
-
longestName
Longest of the names(), used to present usage() alphabetically
-
-
Constructor Details
-
ParameterDescription
public ParameterDescription(Object object, DynamicParameter annotation, Parameterized parameterized, ResourceBundle bundle, JCommander jc) -
ParameterDescription
public ParameterDescription(Object object, Parameter annotation, Parameterized parameterized, ResourceBundle bundle, JCommander jc)
-
-
Method Details
-
findResourceBundle
Find the resource bundle in the annotations.- Returns:
-
isEmpty
-
initDescription
-
init
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
- the object defining the command-line argumentsparameterized
- the wrapper for the field or method annotated with \@Parameter this representsbundle
- the localejCommander
- the parent JCommander instance- See Also:
-
validateDefaultValues
-
getLongestName
-
getDefault
-
getDescription
-
getObject
-
getNames
-
getParameter
-
getParameterized
-
isMultiOption
private boolean isMultiOption() -
addValue
-
isAssigned
public boolean isAssigned()- Returns:
- true if this parameter received a value during the parsing phase.
-
setAssigned
public void setAssigned(boolean b) -
addValue
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
-
handleSubParameters
private Object handleSubParameters(String value, int currentIndex, Class<?> type, List<ParameterDescription.SubParameterIndex> subParameters) -
getParameterAnnotation
-
findSubParameters
-
validateParameter
-
validateValueParameter
-
validateValueParameter
public void validateValueParameter(Class<? extends IValueValidator> validator, String name, Object value) -
validateParameter
public void validateParameter(Class<? extends IParameterValidator> validator, String name, String value) -
newCollection
-
fieldIsSetForTheFirstTime
private boolean fieldIsSetForTheFirstTime(boolean isDefault) -
p
-
toString
-
isDynamicParameter
public boolean isDynamicParameter() -
isHelp
public boolean isHelp() -
isNonOverwritableForced
public boolean isNonOverwritableForced()
-