Class ParameterDescription

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

public class ParameterDescription extends Object
  • Field Details

    • object

      private Object object
    • wrappedParameter

      private WrappedParameter wrappedParameter
    • parameterAnnotation

      private Parameter parameterAnnotation
    • dynamicParameterAnnotation

      private DynamicParameter dynamicParameterAnnotation
    • parameterized

      private Parameterized parameterized
      The field/method
    • assigned

      private boolean assigned
      Keep track of whether a value was added to flag an error
    • bundle

      private ResourceBundle bundle
    • description

      private String description
    • jCommander

      private JCommander jCommander
    • defaultObject

      private Object defaultObject
    • longestName

      private String longestName
      Longest of the names(), used to present usage() alphabetically
  • Constructor Details

  • Method Details

    • findResourceBundle

      private ResourceBundle findResourceBundle(Object o)
      Find the resource bundle in the annotations.
      Returns:
    • isEmpty

      private boolean isEmpty(String s)
    • initDescription

      private void initDescription(String description, String descriptionKey, String[] names)
    • 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 nullinvalid input: '<'. 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 arguments
      parameterized - the wrapper for the field or method annotated with \@Parameter this represents
      bundle - the locale
      jCommander - the parent JCommander instance
      See Also:
    • validateDefaultValues

      private void validateDefaultValues(String[] names)
    • getLongestName

      public String getLongestName()
    • getDefault

      public Object getDefault()
    • getDescription

      public String getDescription()
    • getObject

      public Object getObject()
    • getNames

      public String getNames()
    • getParameter

      public WrappedParameter getParameter()
    • getParameterized

      public Parameterized getParameterized()
    • isMultiOption

      private boolean isMultiOption()
    • 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.
    • addValue

      Object addValue(String name, String value, boolean isDefault, boolean validate, int currentIndex)
    • handleSubParameters

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

      public Parameter getParameterAnnotation()
    • findSubParameters

      private List<ParameterDescription.SubParameterIndex> findSubParameters(Class<?> type)
    • validateParameter

      private void validateParameter(String name, String value)
    • validateValueParameter

      void validateValueParameter(String name, Object value)
    • 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

      private Collection<Object> newCollection(Class<?> type)
    • fieldIsSetForTheFirstTime

      private boolean fieldIsSetForTheFirstTime(boolean isDefault)
    • p

      private void p(String string)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • isDynamicParameter

      public boolean isDynamicParameter()
    • isHelp

      public boolean isHelp()
    • isNonOverwritableForced

      public boolean isNonOverwritableForced()