org.apache.gobblin.runtime.cli

Class PublicMethodsCliObjectFactory<T>

java.lang.Object

org.apache.gobblin.runtime.cli.PublicMethodsCliObjectFactory<T>

All Implemented Interfaces:

CliObjectFactory<T>

Direct Known Subclasses:

ConstructorAndPublicMethodsCliObjectFactory

public abstract class PublicMethodsCliObjectFactory<T>
extends Object
implements CliObjectFactory<T>

A helper class for automatically inferring Options from the public methods in a class. For each public method in the class to infer with exactly zero or one String parameter, the helper will create an optional Option. Using the annotation CliObjectOption the helper can automatically add a description to the Option. Annotating a method with NotOnCli will prevent the helper from creating an Option from it.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.gobblin.runtime.cli.CliObjectFactory

CliObjectFactory.HelpArgumentFound

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<? extends T>	klazz

Constructor Summary

Constructors

Constructor and Description
PublicMethodsCliObjectFactory(Class<? extends T> klazz)

Method Summary

Modifier and Type	Method and Description
void	applyCommandLineOptions(org.apache.commons.cli.CommandLine cli, T embeddedGobblin) For each method for which the helper created an Option and for which the input CommandLine contains that option, this method will automatically call the method on the input object with the correct arguments.
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.
protected abstract T	constructObject(org.apache.commons.cli.CommandLine cli)
String	getUsageString() Get a usage string for display on the command line.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.gobblin.runtime.cli.CliObjectFactory

getOptions

Field Detail

klazz

protected final Class<? extends T> klazz

Constructor Detail

PublicMethodsCliObjectFactory

public PublicMethodsCliObjectFactory(Class<? extends T> klazz)

Method Detail

buildObject

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

Description copied from interface: CliObjectFactory

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.

Specified by:

buildObject in interface CliObjectFactory<T>

buildObject

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

Description copied from interface: CliObjectFactory

Build an instance of T from the input arguments.

Specified by:

buildObject in interface CliObjectFactory<T>

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

constructObject

protected abstract T constructObject(org.apache.commons.cli.CommandLine cli)
                              throws IOException

Throws:

IOException

getUsageString

public String getUsageString()

Description copied from interface: CliObjectFactory

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.

Specified by:

getUsageString in interface CliObjectFactory<T>

applyCommandLineOptions

public void applyCommandLineOptions(org.apache.commons.cli.CommandLine cli,
                                    T embeddedGobblin)

For each method for which the helper created an Option and for which the input CommandLine contains that option, this method will automatically call the method on the input object with the correct arguments.