| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_40) on Thu Jul 20 13:15:29 PDT 2017 --> |
| <title>PublicMethodsCliObjectFactory (gobblin-utility 0.11.0 API)</title> |
| <meta name="date" content="2017-07-20"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PublicMethodsCliObjectFactory (gobblin-utility 0.11.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../gobblin/runtime/cli/NotOnCli.html" title="annotation in gobblin.runtime.cli"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" target="_top">Frames</a></li> |
| <li><a href="PublicMethodsCliObjectFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">gobblin.runtime.cli</div> |
| <h2 title="Class PublicMethodsCliObjectFactory" class="title">Class PublicMethodsCliObjectFactory<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>gobblin.runtime.cli.PublicMethodsCliObjectFactory<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../gobblin/runtime/cli/CliObjectFactory.html" title="interface in gobblin.runtime.cli">CliObjectFactory</a><T></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../gobblin/runtime/cli/ConstructorAndPublicMethodsCliObjectFactory.html" title="class in gobblin.runtime.cli">ConstructorAndPublicMethodsCliObjectFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">PublicMethodsCliObjectFactory<T></span> |
| extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../gobblin/runtime/cli/CliObjectFactory.html" title="interface in gobblin.runtime.cli">CliObjectFactory</a><T></pre> |
| <div class="block">A helper class for automatically inferring <code>Option</code>s 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 <code>Option</code>. Using the annotation <a href="../../../gobblin/runtime/cli/CliObjectOption.html" title="annotation in gobblin.runtime.cli"><code>CliObjectOption</code></a> the helper can automatically |
| add a description to the <code>Option</code>. Annotating a method with <a href="../../../gobblin/runtime/cli/NotOnCli.html" title="annotation in gobblin.runtime.cli"><code>NotOnCli</code></a> will prevent the helper from |
| creating an <code>Option</code> from it.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.gobblin.runtime.cli.CliObjectFactory"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface gobblin.runtime.cli.<a href="../../../gobblin/runtime/cli/CliObjectFactory.html" title="interface in gobblin.runtime.cli">CliObjectFactory</a></h3> |
| <code><a href="../../../gobblin/runtime/cli/CliObjectFactory.HelpArgumentFound.html" title="class in gobblin.runtime.cli">CliObjectFactory.HelpArgumentFound</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html#klazz">klazz</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html#PublicMethodsCliObjectFactory-java.lang.Class-">PublicMethodsCliObjectFactory</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a>> klazz)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html#applyCommandLineOptions-org.apache.commons.cli.CommandLine-T-">applyCommandLineOptions</a></span>(org.apache.commons.cli.CommandLine cli, |
| <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a> embeddedGobblin)</code> |
| <div class="block">For each method for which the helper created an <code>Option</code> and for which the input <code>CommandLine</code> contains |
| that option, this method will automatically call the method on the input object with the correct |
| arguments.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html#buildObject-org.apache.commons.cli.CommandLine-">buildObject</a></span>(org.apache.commons.cli.CommandLine cli)</code> |
| <div class="block">Build an instance of T from the parsed <code>CommandLine</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html#buildObject-java.lang.String:A-int-boolean-java.lang.String-">buildObject</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, |
| int offset, |
| boolean printUsage, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usage)</code> |
| <div class="block">Build an instance of T from the input arguments.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html#constructObject-org.apache.commons.cli.CommandLine-">constructObject</a></span>(org.apache.commons.cli.CommandLine cli)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html#getUsageString--">getUsageString</a></span>()</code> |
| <div class="block">Get a usage string for display on the command line.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.gobblin.runtime.cli.CliObjectFactory"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface gobblin.runtime.cli.<a href="../../../gobblin/runtime/cli/CliObjectFactory.html" title="interface in gobblin.runtime.cli">CliObjectFactory</a></h3> |
| <code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html#getOptions--">getOptions</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="klazz"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>klazz</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a>> klazz</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PublicMethodsCliObjectFactory-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PublicMethodsCliObjectFactory</h4> |
| <pre>public PublicMethodsCliObjectFactory(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a>> klazz)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="buildObject-org.apache.commons.cli.CommandLine-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildObject</h4> |
| <pre>public <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a> buildObject(org.apache.commons.cli.CommandLine cli)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html#buildObject-org.apache.commons.cli.CommandLine-">CliObjectFactory</a></code></span></div> |
| <div class="block">Build an instance of T from the parsed <code>CommandLine</code>. The input <code>CommandLine</code> was parsed with |
| the output of <code>Options</code>, but may include additional <code>Option</code>s added by the driver.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html#buildObject-org.apache.commons.cli.CommandLine-">buildObject</a></code> in interface <code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html" title="interface in gobblin.runtime.cli">CliObjectFactory</a><<a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildObject-java.lang.String:A-int-boolean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildObject</h4> |
| <pre>public <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a> buildObject(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args, |
| int offset, |
| boolean printUsage, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usage) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html#buildObject-java.lang.String:A-int-boolean-java.lang.String-">CliObjectFactory</a></code></span></div> |
| <div class="block">Build an instance of T from the input arguments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html#buildObject-java.lang.String:A-int-boolean-java.lang.String-">buildObject</a></code> in interface <code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html" title="interface in gobblin.runtime.cli">CliObjectFactory</a><<a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - input arguments to the application.</dd> |
| <dd><code>offset</code> - will only start processing from this argument number.</dd> |
| <dd><code>printUsage</code> - if true, a failure or -h will cause help to be printed and an exception to be thrown.</dd> |
| <dd><code>usage</code> - usage String to be printed at the beginning of help message.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="constructObject-org.apache.commons.cli.CommandLine-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>constructObject</h4> |
| <pre>protected abstract <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a> constructObject(org.apache.commons.cli.CommandLine cli) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUsageString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUsageString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getUsageString()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html#getUsageString--">CliObjectFactory</a></code></span></div> |
| <div class="block">Get a usage string for display on the command line. The output of this method will be appended to the base string |
| "gobblin run <appName>". This should specify required options or parameters.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html#getUsageString--">getUsageString</a></code> in interface <code><a href="../../../gobblin/runtime/cli/CliObjectFactory.html" title="interface in gobblin.runtime.cli">CliObjectFactory</a><<a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="applyCommandLineOptions-org.apache.commons.cli.CommandLine-java.lang.Object-"> |
| <!-- --> |
| </a><a name="applyCommandLineOptions-org.apache.commons.cli.CommandLine-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>applyCommandLineOptions</h4> |
| <pre>public void applyCommandLineOptions(org.apache.commons.cli.CommandLine cli, |
| <a href="../../../gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" title="type parameter in PublicMethodsCliObjectFactory">T</a> embeddedGobblin)</pre> |
| <div class="block">For each method for which the helper created an <code>Option</code> and for which the input <code>CommandLine</code> contains |
| that option, this method will automatically call the method on the input object with the correct |
| arguments.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../gobblin/runtime/cli/NotOnCli.html" title="annotation in gobblin.runtime.cli"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?gobblin/runtime/cli/PublicMethodsCliObjectFactory.html" target="_top">Frames</a></li> |
| <li><a href="PublicMethodsCliObjectFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
