com.beust.jcommander
Class ParameterDescription

java.lang.Object
  extended by com.beust.jcommander.ParameterDescription

public class ParameterDescription
extends Object


Constructor Summary
ParameterDescription(Object object, Parameter annotation, Field field, ResourceBundle bundle, JCommander jc)
           
 
Method Summary
 void addValue(String value)
           
 void addValue(String value, boolean isDefault)
          Add the specified value to the field.
 Object getDefault()
           
 String getDescription()
           
 Field getField()
           
 String getLongestName()
           
 String getNames()
           
 Object getObject()
           
 Parameter getParameter()
           
 boolean isAssigned()
           
 boolean isNumber()
           
 void setAssigned(boolean b)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ParameterDescription

public ParameterDescription(Object object,
                            Parameter annotation,
                            Field field,
                            ResourceBundle bundle,
                            JCommander jc)
Method Detail

getLongestName

public String getLongestName()

getDefault

public Object getDefault()

getDescription

public String getDescription()

getObject

public Object getObject()

getNames

public String getNames()

getParameter

public Parameter getParameter()

getField

public Field getField()

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.


isNumber

public boolean isNumber()

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2011. All Rights Reserved.