Package com.beust.jcommander

Class ParameterDescription

java.lang.Object

com.beust.jcommander.ParameterDescription

public class ParameterDescription
extends Object

Constructor Summary

Constructors

Constructor	Description
ParameterDescription(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 Type	Method	Description
void	addValue(String value)
void	addValue(String value, boolean isDefault)	Add the specified value to the field.
String	getCategory()
Object	getDefault()
Object	getDefaultValueDescription()
String	getDescription()
String	getLongestName()
String	getNames()
Object	getObject()
WrappedParameter	getParameter()
Parameter	getParameterAnnotation()
Parameterized	getParameterized()
boolean	isAssigned()
boolean	isDynamicParameter()
boolean	isHelp()
boolean	isNonOverwritableForced()
void	setAssigned(boolean b)
String	toString()
void	validateParameter(Class<? extends IParameterValidator> validator, String name, String value)
void	validateValueParameter(Class<? extends IValueValidator> validator, String name, Object value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getLongestName

public String getLongestName()

getDefault

public Object getDefault()

getDefaultValueDescription

public Object getDefaultValueDescription()

Returns:

defaultValueDescription, if description is empty string, return default Object.

getDescription

public String getDescription()

getObject

public Object getObject()

getNames

public String getNames()

getCategory

public String getCategory()

getParameter

public WrappedParameter getParameter()

getParameterized

public Parameterized getParameterized()

addValue

public void addValue(String value)

isAssigned

public boolean isAssigned()

Returns:

true if this parameter received a value during the parsing phase.

setAssigned

public void setAssigned(boolean b)

addValue

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.

getParameterAnnotation

public Parameter getParameterAnnotation()

validateValueParameter

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

validateParameter

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

toString

public String toString()

Overrides:

toString in class Object

isDynamicParameter

public boolean isDynamicParameter()

isHelp

public boolean isHelp()

isNonOverwritableForced

public boolean isNonOverwritableForced()