Top Description Fields Constructors Methods
org.kohsuke.args4j.spi

public Class StringOptionHandler

extends OptionHandler<String>
Class Inheritance
Imports
org.kohsuke.args4j.OptionDef, .CmdLineException, .CmdLineParser
String OptionHandler.
Author
Kohsuke Kawaguchi

Field Summary

Inherited from org.kohsuke.args4j.spi.OptionHandler:
optionownersetter

Constructor Summary

AccessConstructor and Description
public
StringOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super String> setter)

Method Summary

Modifier and TypeMethod and Description
public String
getDefaultMetaVariable()

Implements abstract org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

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

public int
parseArguments(Parameters
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.
params)

Implements abstract org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Called if the option that this owner recognizes is found.

Inherited from org.kohsuke.args4j.spi.OptionHandler:
getMetaVariablegetNameAndMetagetNameAndMetaprintprintDefaultValue

Constructor Detail

StringOptionHandlerback to summary
public StringOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super String> setter)

Method Detail

getDefaultMetaVariableback to summary
public String getDefaultMetaVariable()

Implements abstract org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

Doc from org.kohsuke.args4j.spi.OptionHandler.getDefaultMetaVariable.

Gets the default meta variable name used to print the usage screen. The value returned by this method can be a reference in the ResourceBundle, if one was passed to CmdLineParser.

Returns:String

null to hide a meta variable.

Annotations
@Override
parseArgumentsback to summary
public int parseArguments(Parameters params) throws CmdLineException

Implements abstract org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Doc from org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Called if the option that this owner recognizes is found.

Parameters
params:Parameters

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

The number of arguments consumed. (For example, returns 0 if this option doesn't take any parameters.)

Annotations
@Override