Top Description Fields Constructors Methods
org.kohsuke.args4j.spi

public Class MapOptionHandler

extends OptionHandler<Map<?, ?>>
Class Inheritance
Imports
java.util.HashMap, .Map, org.kohsuke.args4j.*
Parses options into a Map. 

class Foo {
 @Option(name="-P",handler=MapOptionHandler.class)
  Map<String,String> args;
}

With this, -P x=1 -P y=2 parses to map of size 2. This option handler can be subtyped if you want to convert values to different types or to handle key=value in other formats, like key:=value.

Field Summary

Inherited from org.kohsuke.args4j.spi.OptionHandler:
optionownersetter

Constructor Summary

AccessConstructor and Description
public
MapOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super Map<?, ?>> setter)

Method Summary

Modifier and TypeMethod and Description
protected void
addToMap(String argument, Map<K, V> m)

Encapsulates how a single string argument gets converted into key and value.

protected void
addToMap(Map<K, V> m, String key, String value)

This is the opportunity to convert values to some typed objects.

protected Map<K, V>
createNewCollection(Class<? extends Map<K, V>> type)

Creates a new instance of the collection.

public String
getDefaultMetaVariable()

Implements abstract org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

Gets the default meta variable name used to print the usage screen.

public int
parseArguments(Parameters
The rest of the arguments. This method can use this object to access the arguments of the option if necessary. The object is valid only during the method call.
params)

Implements abstract org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Called if the option that this owner recognizes is found.

Inherited from org.kohsuke.args4j.spi.OptionHandler:
getMetaVariablegetNameAndMetagetNameAndMetaprintprintDefaultValue

Constructor Detail

MapOptionHandlerback to summary
public MapOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super Map<?, ?>> setter)

Method Detail

addToMapback to summary
protected void addToMap(String argument, Map<K, V> m) throws CmdLineException

Encapsulates how a single string argument gets converted into key and value.

addToMapback to summary
protected void addToMap(Map<K, V> m, String key, String value)

This is the opportunity to convert values to some typed objects.

createNewCollectionback to summary
protected Map<K, V> createNewCollection(Class<? extends Map<K, V>> type)

Creates a new instance of the collection.

getDefaultMetaVariableback to summary
public String getDefaultMetaVariable()

Implements abstract org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

Doc from org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

Gets the default meta variable name used to print the usage screen. The value returned by this method can be a reference in the ResourceBundle, if one was passed to CmdLineParser.

Returns:String

null to hide a meta variable.

Annotations
@Override
parseArgumentsback to summary
public int parseArguments(Parameters params) throws CmdLineException

Implements abstract org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Doc from org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Called if the option that this owner recognizes is found.

Parameters
params:Parameters

The rest of the arguments. This method can use this object to access the arguments of the option if necessary. The object is valid only during the method call.

Returns:int

The number of arguments consumed. (For example, returns 0 if this option doesn't take any parameters.)

Annotations
@Override