org.kohsuke.args4j.spi

Class StringArrayOptionHandler

java.lang.Object

org.kohsuke.args4j.spi.OptionHandler<String[]>

org.kohsuke.args4j.spi.StringArrayOptionHandler

public class StringArrayOptionHandler
extends OptionHandler<String[]>

An OptionHandler for handling String[] types. Can handle arrays of strings.

How it works:

Example for parameter -s, which is String[] type:
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

It will handle all of these posibilites. This OptionHandler scans for parameter which begins with "-". If it found it, it will stop.

Author:

PlainText,LuVar

Field Summary

Fields inherited from class org.kohsuke.args4j.spi.OptionHandler

option, owner, setter

Constructor Summary

Constructors

Constructor and Description
StringArrayOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super String[]> setter)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultMetaVariable() Returns "STRING[]".
int	parseArguments(Parameters params) Tryies to parse String[] argument from Parameters.

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

StringArrayOptionHandler

public StringArrayOptionHandler(CmdLineParser parser,
                        OptionDef option,
                        Setter<? super String[]> setter)

Method Detail

getDefaultMetaVariable

public String getDefaultMetaVariable()

Returns "STRING[]".

Specified by:

getDefaultMetaVariable in class OptionHandler<String[]>

Returns:

return "STRING[]";

parseArguments

public int parseArguments(Parameters params)
                   throws CmdLineException

Tryies to parse String[] argument from Parameters.

Specified by:

parseArguments in class OptionHandler<String[]>

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