args4j 2.37 · org.kohsuke.args4j.spi.Setter · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	addValue(T value) Adds/sets a value to the property of the option bean.
public AnnotatedElement	asAnnotatedElement() Returns the `AnnotatedElement` by which you can access annotations written on this setter.
public FieldSetter	Returns: `null` if this setter wraps a method. asFieldSetter() If this setter encapsulates a field, return the direct access to that field as `FieldSetter`.
public Class<T>	getType() Gets the type of the underlying method/field.
public boolean	isMultiValued() Whether this setter is intrinsically multi-valued.

Method Detail

addValue back to summary

addValue	back to summary
public void addValue(T value) throws CmdLineException Adds/sets a value to the property of the option bean. A `Setter` object has an implicit knowledge about the property it's setting, and the instance of the option bean.

public void addValue(T value) throws CmdLineException

Adds/sets a value to the property of the option bean.

A Setter object has an implicit knowledge about the property it's setting, and the instance of the option bean.

asAnnotatedElement back to summary

asAnnotatedElement	back to summary
public AnnotatedElement asAnnotatedElement() Returns the `AnnotatedElement` by which you can access annotations written on this setter. This is the same `AnnotatedElement` that had `Option`/`Argument`. This enables `OptionHandler` to further tweak its behavior based on additional annotations.

public AnnotatedElement asAnnotatedElement()

Returns the AnnotatedElement by which you can access annotations written on this setter. This is the same AnnotatedElement that had Option/Argument.

This enables OptionHandler to further tweak its behavior based on additional annotations.

asFieldSetter back to summary

asFieldSetter	back to summary
public FieldSetter asFieldSetter() If this setter encapsulates a field, return the direct access to that field as `FieldSetter`. This method serves two purposes: This lets `OptionHandler`s bypass the collection/array handling of fields. This is useful if you're defining an option handler that produces array or collection from a single argument. The other is to retrieve the current value of the field (via `FieldSetter#getValueList()`). Returns:FieldSetter `null` if this setter wraps a method.

public FieldSetter asFieldSetter()

If this setter encapsulates a field, return the direct access to that field as FieldSetter. This method serves two purposes:

This lets OptionHandlers bypass the collection/array handling of fields. This is useful if you're defining an option handler that produces array or collection from a single argument.
The other is to retrieve the current value of the field (via FieldSetter#getValueList()).

Returns:FieldSetter: null if this setter wraps a method.

getType	back to summary
public Class<T> getType() Gets the type of the underlying method/field.

isMultiValued back to summary

isMultiValued	back to summary
public boolean isMultiValued() Whether this setter is intrinsically multi-valued. When parsing arguments (instead of options), intrinsically multi-valued setters consume all the remaining arguments. So, if the setter can store multiple values, this method should return `true`. This characteristics of a setter doesn't affect option parsing at all; any options can be specified multiple times. In many cases, this is a no-op--but when your shell script expands multiple environment variables (each of which may contain options), tolerating such redundant options can be useful.

public boolean isMultiValued()

Whether this setter is intrinsically multi-valued.

When parsing arguments (instead of options), intrinsically multi-valued setters consume all the remaining arguments. So, if the setter can store multiple values, this method should return true.

This characteristics of a setter doesn't affect option parsing at all; any options can be specified multiple times. In many cases, this is a no-op--but when your shell script expands multiple environment variables (each of which may contain options), tolerating such redundant options can be useful.

public Interface Setter<T>

Method Summary

Method Detail