org.kohsuke.args4j.spi
Class OneArgumentOptionHandler<T>

java.lang.Object
  extended by org.kohsuke.args4j.spi.OptionHandler<T>
      extended by org.kohsuke.args4j.spi.OneArgumentOptionHandler<T>
Type Parameters:
T - Type of the Setter-class
Direct Known Subclasses:
ByteOptionHandler, CharOptionHandler, DoubleOptionHandler, FloatOptionHandler, IntOptionHandler, LongOptionHandler, ShortOptionHandler

public abstract class OneArgumentOptionHandler<T>
extends OptionHandler<T>

OptionHandler which handles an option with exactly one argument, like "-foo bar".

Since:
2.0.9
Author:
Jan Materne

Field Summary
 
Fields inherited from class org.kohsuke.args4j.spi.OptionHandler
option, owner, setter
 
Constructor Summary
OneArgumentOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> setter)
           
 
Method Summary
 String getDefaultMetaVariable()
          Gets the default meta variable name used to print the usage screen.
protected abstract  T parse(String argument)
          Parses a string to a real value of Type <T>.
 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

OneArgumentOptionHandler

public OneArgumentOptionHandler(CmdLineParser parser,
                                OptionDef option,
                                Setter<? super T> 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<T>
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<T>
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

parse

protected abstract T parse(String argument)
                    throws NumberFormatException,
                           CmdLineException
Parses a string to a real value of Type <T>.

Parameters:
argument - String value to parse
Returns:
the parsed value
Throws:
NumberFormatException - if parsing is not possible
CmdLineException - if the parsing encounters a failure that should be reported to the user.


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