Top Description Constructors Methods
org.kohsuke.args4j.spi

public Class PathOptionHandler

extends OneArgumentOptionHandler<Path>
Class Inheritance
Imports
org.kohsuke.args4j.CmdLineException, .CmdLineParser, .OptionDef, java.nio.file.Path, .Paths
Takes a single argument to the option and maps that to Path.
Author
kmahoney

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
public String
getDefaultMetaVariable()

Overrides org.kohsuke.args4j.spi.OneArgumentOptionHandler.getDefaultMetaVariable.

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

protected Path
parse(String
String value to parse
argument)

Implements abstract org.kohsuke.args4j.spi.OneArgumentOptionHandler.parse.

Parses a string to a real value of Type <T>.

Inherited from org.kohsuke.args4j.spi.OneArgumentOptionHandler:
parseArguments

Constructor Detail

PathOptionHandlerback to summary
public PathOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super Path> setter)

Method Detail

getDefaultMetaVariableback to summary
public String getDefaultMetaVariable()

Overrides org.kohsuke.args4j.spi.OneArgumentOptionHandler.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
parseback to summary
protected Path parse(String argument) throws NumberFormatException, CmdLineException

Implements abstract org.kohsuke.args4j.spi.OneArgumentOptionHandler.parse.

Doc from org.kohsuke.args4j.spi.OneArgumentOptionHandler.parse.

Parses a string to a real value of Type <T>.

Parameters
argument:String

String value to parse

Returns:Path

the parsed value

Annotations
@Override
Exceptions
NumberFormatException:
if parsing is not possible
CmdLineException:
if the parsing encounters a failure that should be reported to the user.