gobblin.runtime.cli

Interface CliObjectFactory<T>

All Known Implementing Classes:

ConstructorAndPublicMethodsCliObjectFactory, PublicMethodsCliObjectFactory

public interface CliObjectFactory<T>

A factory used to create an object from CLI arguments backed by commons-cli library.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CliObjectFactory.HelpArgumentFound Thrown if help argument (-h) was found in the app arguments.

Method Summary

Modifier and Type	Method and Description
T	buildObject(org.apache.commons.cli.CommandLine cli) Build an instance of T from the parsed CommandLine.
T	buildObject(String[] args, int offset, boolean printUsage, String usage) Build an instance of T from the input arguments.
org.apache.commons.cli.Options	getOptions()
String	getUsageString() Get a usage string for display on the command line.

Method Detail

getOptions

org.apache.commons.cli.Options getOptions()

Returns:

an instance of Options understood by this factory.

buildObject

T buildObject(org.apache.commons.cli.CommandLine cli)

Build an instance of T from the parsed CommandLine. The input CommandLine was parsed with the output of Options, but may include additional Options added by the driver.

buildObject

T buildObject(String[] args,
              int offset,
              boolean printUsage,
              String usage)
       throws IOException

Build an instance of T from the input arguments.

Parameters:

args - input arguments to the application.

offset - will only start processing from this argument number.

printUsage - if true, a failure or -h will cause help to be printed and an exception to be thrown.

usage - usage String to be printed at the beginning of help message.

Throws:

IOException

getUsageString

String getUsageString()

Get a usage string for display on the command line. The output of this method will be appended to the base string "gobblin run ". This should specify required options or parameters.