org.pantsbuild.args4j

Class ArgfileOptionHandler<T>

java.lang.Object

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

org.pantsbuild.args4j.ArgfileOptionHandler<T>

Type Parameters:

T - The type of the underlying option value.

public abstract class ArgfileOptionHandler<T>
extends org.kohsuke.args4j.spi.OptionHandler<T>

An OptionHandler that can read an option value from an "argfile".

An argfile is just a file containing an option's value as its contents. These can be useful to avoid command-line argument length limits. An argfile is specified on the command-line by prefixing the option argument value with a @, like so:

-potenially-long-argument=@/path/to/argfile

The path can be relative in which case it is taken as relative to the working directory of the associated java invocation.

Field Summary

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

option, owner, setter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArgfileOptionHandler(org.kohsuke.args4j.spi.OptionHandler<T> delegate)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultMetaVariable()
int	parseArguments(org.kohsuke.args4j.spi.Parameters params)

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

getMetaVariable, getNameAndMeta, getNameAndMeta, print, printDefaultValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgfileOptionHandler

protected ArgfileOptionHandler(org.kohsuke.args4j.spi.OptionHandler<T> delegate)

Parameters:

delegate - The OptionHandler to delegate final value parsing to.

Method Detail

parseArguments

public int parseArguments(org.kohsuke.args4j.spi.Parameters params)
                   throws org.kohsuke.args4j.CmdLineException

Specified by:

parseArguments in class org.kohsuke.args4j.spi.OptionHandler<T>

Throws:

org.kohsuke.args4j.CmdLineException

getDefaultMetaVariable

public java.lang.String getDefaultMetaVariable()

Specified by:

getDefaultMetaVariable in class org.kohsuke.args4j.spi.OptionHandler<T>