args4j 2.0.12-redhat-2

org.kohsuke.args4j.spi
Class MapOptionHandler

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

public class MapOptionHandler
extends OptionHandler<Map<?,?>>


Field Summary
 
Fields inherited from class org.kohsuke.args4j.spi.OptionHandler
option, owner, setter
 
Constructor Summary
MapOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super Map<?,?>> setter)
           
 
Method Summary
 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 Map<?,?>> setter)
Method Detail

getDefaultMetaVariable

public 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<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<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

args4j 2.0.12-redhat-2

Copyright © 2003-2012 JBoss by Red Hat. All Rights Reserved.