org.kohsuke.args4j.spi
Class BooleanOptionHandler

java.lang.Object
  extended by org.kohsuke.args4j.spi.OptionHandler<Boolean>
      extended by org.kohsuke.args4j.spi.BooleanOptionHandler

public class BooleanOptionHandler
extends OptionHandler<Boolean>

Boolean OptionHandler.

Author:
Kohsuke Kawaguchi

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

BooleanOptionHandler

public BooleanOptionHandler(CmdLineParser parser,
                            OptionDef option,
                            Setter<? super Boolean> setter)
Method Detail

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

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<Boolean>
Returns:
null to hide a meta variable.


Copyright © 2003-2011 Kohsuke Kawaguchi. All Rights Reserved.