org.kohsuke.args4j.spi
Class MapOptionHandler

java.lang.Object
  org.kohsuke.args4j.spi.OptionHandler<java.util.Map<?,?>>
      org.kohsuke.args4j.spi.MapOptionHandler

public class MapOptionHandler
extends OptionHandler<java.util.Map<?,?>>

Field Summary

Fields inherited from class org.kohsuke.args4j.spi.OptionHandler

option, owner, setter

Constructor Summary

MapOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super java.util.Map<?,?>> setter)

Method Summary

java.lang.String	getDefaultMetaVariable() Gets the default meta variable name used to print the usage screen.
int	parseArguments(Parameters params) Called if the option that this owner recognizes is found.

Methods inherited from class org.kohsuke.args4j.spi.OptionHandler

getMetaVariable, getNameAndMeta

Methods inherited from class java.lang.Object

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

Constructor Detail

MapOptionHandler

public MapOptionHandler(CmdLineParser parser,
                        OptionDef option,
                        Setter<? super java.util.Map<?,?>> setter)

Method Detail

getDefaultMetaVariable

public java.lang.String getDefaultMetaVariable()

Description copied from class: OptionHandler

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

Specified by:

getDefaultMetaVariable in class OptionHandler<java.util.Map<?,?>>

Returns:

null to hide a meta variable.

parseArguments

public int parseArguments(Parameters params)
                   throws CmdLineException

Description copied from class: OptionHandler

Called if the option that this owner recognizes is found.

Specified by:

parseArguments in class OptionHandler<java.util.Map<?,?>>

Parameters:

params - 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:

The number of arguments consumed. For example, return 0 if this option doesn't take any parameter.

Throws:

CmdLineException