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

public Class StringArrayOptionHandler

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

An OptionHandler for greedily mapping a list of tokens into a collection of Strings (such as String[], List<String>, etc.).

How it works:

Example for parameter -s, which is type String[]:

java -jar aaa.jar -s banan hruska jablko
java -jar aaa.jar -s banan "hruska jablko"
java -jar aaa.jar -s "banan hruska jablko"
java -jar aaa.jar -s banan hruska jablko -l 4 -r
java -jar aaa.jar -t 222 -s banan hruska jablko -r

All of them result in a single string array that contains three tokens: banan, hruska, and jablko.

This OptionHandler scans for parameter which begins with -. If found, it will stop.

Author
PlainText,LuVar

Field Summary

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

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

return "STRING[]";
getDefaultMetaVariable
()

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

Returns "STRING[]".

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.

Tries to parse String[] argument from Parameters.

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

Constructor Detail

StringArrayOptionHandlerback to summary
public StringArrayOptionHandler(CmdLineParser parser, OptionDef option, Setter<String> setter)

Method Detail

getDefaultMetaVariableback to summary
public String getDefaultMetaVariable()

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

Returns "STRING[]".

Returns:String

return "STRING[]";

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

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

Tries to parse String[] argument from Parameters.

Parameters
params:Parameters

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

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

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

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

Annotations
@Override