org.kohsuke.args4j.opts
Class IntOption

java.lang.Object
  extended by org.kohsuke.args4j.opts.IntOption
All Implemented Interfaces:
CmdLineOption

public class IntOption
extends Object
implements CmdLineOption

Option that takes a int as a parameter.

For example, you can parse "-n 9" or "-n 0" into 9 and 0 respectively.

Author:
Kohsuke Kawaguchi (kk@kohsuke.org)

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.kohsuke.args4j.CmdLineOption
CmdLineOption.Parameters
 
Field Summary
 boolean isSet
          True if the option was explicitly set.
 int value
          Value of this option.
 
Constructor Summary
IntOption(String optionName)
           
IntOption(String optionName, int defaultValue)
           
 
Method Summary
 boolean accepts(String optionName)
          Checks if this option parser recognizes the specified option name.
 int parseArguments(CmdLineParser parser, CmdLineOption.Parameters params)
          Called if the option that this parser recognizes is found.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

value

public int value
Value of this option.


isSet

public boolean isSet
True if the option was explicitly set.

Constructor Detail

IntOption

public IntOption(String optionName)

IntOption

public IntOption(String optionName,
                 int defaultValue)
Method Detail

accepts

public boolean accepts(String optionName)
Description copied from interface: CmdLineOption
Checks if this option parser recognizes the specified option name.

Specified by:
accepts in interface CmdLineOption

parseArguments

public int parseArguments(CmdLineParser parser,
                          CmdLineOption.Parameters params)
                   throws CmdLineException
Description copied from interface: CmdLineOption
Called if the option that this parser recognizes is found.

Specified by:
parseArguments in interface CmdLineOption
Parameters:
parser - The parser that's using this option object. For example, if the option "-quiet" is simply an alias to "-verbose 5", then the implementation can just call the CmdLineParser.parse(String[]) method recursively.
params - The rest of the arguments. This method can use this object to access the arguments of the option if necessary.
Returns:
The number of arguments consumed. For example, return 0 if this option doesn't take any parameter.
Throws:
CmdLineException


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