org.pantsbuild.args4j

Class CollectionOptionHandler<T>

java.lang.Object

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

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

org.pantsbuild.args4j.CollectionOptionHandler<T>

Type Parameters:

T - The type of the underlying option values stored in the container.

public class CollectionOptionHandler<T>
extends org.kohsuke.args4j.spi.DelimitedOptionHandler<T>

An OptionHandler that accepts a list of values to add to an underlying collection option value.

This handler interprets the raw option value as a comma-delimited list and passes the individual list values to a delegate CollectionOptionHandler.ItemParser strategy to obtain collection members from.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CollectionOptionHandler.ItemParser<T> A strategy for parsing an individual option value from a String.

Field Summary

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

delimiter, individualOptionHandler

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

option, owner, setter

Constructor Summary

Constructors

Constructor and Description
CollectionOptionHandler(org.kohsuke.args4j.CmdLineParser parser, org.kohsuke.args4j.OptionDef option, org.kohsuke.args4j.spi.Setter<? super T> setter, java.lang.String defaultMetaVariable, CollectionOptionHandler.ItemParser<T> itemParser)

Method Summary

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

getDefaultMetaVariable, parseArguments, printDefaultValue

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

Constructor Detail

CollectionOptionHandler

public CollectionOptionHandler(org.kohsuke.args4j.CmdLineParser parser,
                               org.kohsuke.args4j.OptionDef option,
                               org.kohsuke.args4j.spi.Setter<? super T> setter,
                               java.lang.String defaultMetaVariable,
                               CollectionOptionHandler.ItemParser<T> itemParser)

Parameters:

parser - The parser being used to parse this option.

option - Metadata describing the option being parsed.

setter - A helper that can add parsed values to the underlying collection option value.

defaultMetaVariable - The default meta variable to use to describe the individual items in the collection.

itemParser - The strategy for parsing individual option values with to populate the underlying collection option value with.