Package org.kohsuke.args4j.spi

Class DelimitedOptionHandler<T>

java.lang.Object

org.kohsuke.args4j.spi.OptionHandler<T>

org.kohsuke.args4j.spi.DelimitedOptionHandler<T>

Direct Known Subclasses:

MultiFileOptionHandler, MultiPathOptionHandler

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

Partial OptionHandler implementation that takes a single value to the option, which is then gets split into individual tokens using fixed delimiter.

This class is marked as abstract even though it has no abstract methods to indicate that the class cannot be used by itself in Option.handler(), due to the extra argument that it takes.

Author:

kmahoney

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	delimiter
protected OneArgumentOptionHandler<? extends T>	individualOptionHandler

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

option, owner, setter

Constructor Summary

Constructors

Constructor	Description
DelimitedOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> setter, java.lang.String delimiter, OneArgumentOptionHandler<? extends T> individualOptionHandler)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefaultMetaVariable()	Gets the default meta variable name used to print the usage screen.
int	parseArguments(Parameters params)	Called if the option that this owner recognizes is found.
java.lang.String	printDefaultValue()	Prints the default value by introspecting the current setter as Getter.

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

getMetaVariable, getNameAndMeta, getNameAndMeta, print

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

delimiter

protected final java.lang.String delimiter

individualOptionHandler

protected final OneArgumentOptionHandler<? extends T> individualOptionHandler

Constructor Detail

DelimitedOptionHandler

public DelimitedOptionHandler(CmdLineParser parser,
                              OptionDef option,
                              Setter<? super T> setter,
                              java.lang.String delimiter,
                              OneArgumentOptionHandler<? extends T> individualOptionHandler)

Method Detail

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, returns 0 if this option doesn't take any parameters.)

Throws:

CmdLineException

getDefaultMetaVariable

public java.lang.String getDefaultMetaVariable()

Description copied from class: OptionHandler

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.

Specified by:

getDefaultMetaVariable in class OptionHandler<T>

Returns:

null to hide a meta variable.

printDefaultValue

public java.lang.String printDefaultValue()

Prints the default value by introspecting the current setter as Getter.

Overrides:

printDefaultValue in class OptionHandler<T>

Returns:

null if the current value of the setter isn't available.