blob: 41c6bfbe91130f2463e867202975b353add19790 [file] [log] [blame]
<!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:18:19 PDT 2017 -->
<title>ConstructorAndPublicMethodsGobblinCliFactory (gobblin-runtime 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="ConstructorAndPublicMethodsGobblinCliFactory (gobblin-runtime 0.11.0 API)";
}
}
catch(err) {
}
//-->
</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/CliOptions.html" title="class in gobblin.runtime.cli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/cli/EmbeddedGobblinCliFactory.html" title="interface in gobblin.runtime.cli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/runtime/cli/ConstructorAndPublicMethodsGobblinCliFactory.html" target="_top">Frames</a></li>
<li><a href="ConstructorAndPublicMethodsGobblinCliFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.gobblin.runtime.cli.PublicMethodsCliObjectFactory">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.gobblin.runtime.cli.ConstructorAndPublicMethodsCliObjectFactory">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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 ConstructorAndPublicMethodsGobblinCliFactory" class="title">Class ConstructorAndPublicMethodsGobblinCliFactory</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><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/PublicMethodsCliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">gobblin.runtime.cli.PublicMethodsCliObjectFactory</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/ConstructorAndPublicMethodsCliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">gobblin.runtime.cli.ConstructorAndPublicMethodsCliObjectFactory</a>&lt;<a href="../../../gobblin/runtime/embedded/EmbeddedGobblin.html" title="class in gobblin.runtime.embedded">EmbeddedGobblin</a>&gt;</li>
<li>
<ul class="inheritance">
<li>gobblin.runtime.cli.ConstructorAndPublicMethodsGobblinCliFactory</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">CliObjectFactory</a>&lt;<a href="../../../gobblin/runtime/embedded/EmbeddedGobblin.html" title="class in gobblin.runtime.embedded">EmbeddedGobblin</a>&gt;, <a href="../../../gobblin/runtime/cli/EmbeddedGobblinCliFactory.html" title="interface in gobblin.runtime.cli">EmbeddedGobblinCliFactory</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../gobblin/runtime/embedded/EmbeddedGobblin.CliFactory.html" title="class in gobblin.runtime.embedded">EmbeddedGobblin.CliFactory</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ConstructorAndPublicMethodsGobblinCliFactory</span>
extends <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/ConstructorAndPublicMethodsCliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">ConstructorAndPublicMethodsCliObjectFactory</a>&lt;<a href="../../../gobblin/runtime/embedded/EmbeddedGobblin.html" title="class in gobblin.runtime.embedded">EmbeddedGobblin</a>&gt;
implements <a href="../../../gobblin/runtime/cli/EmbeddedGobblinCliFactory.html" title="interface in gobblin.runtime.cli">EmbeddedGobblinCliFactory</a></pre>
<div class="block">A helper class for automatically inferring <code>Option</code>s from the constructor and public methods in a class.
For method inference, see <a href="../../../gobblin/runtime/cli/PublicMethodsGobblinCliFactory.html" title="class in gobblin.runtime.cli"><code>PublicMethodsGobblinCliFactory</code></a>.
<code>Option</code>s are inferred from the constructor as follows:
1. The helper will search for exactly one constructor with only String arguments and which is annotated with
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectSupport.html?is-external=true" title="class or interface in gobblin.runtime.cli"><code>CliObjectSupport</code></a>.
2. For each parameter of the constructor, the helper will create a required <code>Option</code>.
For an example usage see <code>EmbeddedGobblin.CliFactory</code>.</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&nbsp;gobblin.runtime.cli.<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">CliObjectFactory</a></h3>
<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectFactory.HelpArgumentFound.html?is-external=true" title="class or interface 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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.gobblin.runtime.cli.PublicMethodsCliObjectFactory">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;gobblin.runtime.cli.<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/PublicMethodsCliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">PublicMethodsCliObjectFactory</a></h3>
<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/PublicMethodsCliObjectFactory.html?is-external=true#klazz" title="class or interface in gobblin.runtime.cli">klazz</a></code></li>
</ul>
</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">&nbsp;</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/ConstructorAndPublicMethodsGobblinCliFactory.html#ConstructorAndPublicMethodsGobblinCliFactory-java.lang.Class-">ConstructorAndPublicMethodsGobblinCliFactory</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>&lt;? extends <a href="../../../gobblin/runtime/embedded/EmbeddedGobblin.html" title="class in gobblin.runtime.embedded">EmbeddedGobblin</a>&gt;&nbsp;klazz)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.runtime.cli.ConstructorAndPublicMethodsCliObjectFactory">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.runtime.cli.<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/ConstructorAndPublicMethodsCliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">ConstructorAndPublicMethodsCliObjectFactory</a></h3>
<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/ConstructorAndPublicMethodsCliObjectFactory.html?is-external=true#constructObject-org.apache.commons.cli.CommandLine-" title="class or interface in gobblin.runtime.cli">constructObject</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/ConstructorAndPublicMethodsCliObjectFactory.html?is-external=true#getOptions--" title="class or interface in gobblin.runtime.cli">getOptions</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.runtime.cli.PublicMethodsCliObjectFactory">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.runtime.cli.<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/PublicMethodsCliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">PublicMethodsCliObjectFactory</a></h3>
<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/PublicMethodsCliObjectFactory.html?is-external=true#applyCommandLineOptions-org.apache.commons.cli.CommandLine-T-" title="class or interface in gobblin.runtime.cli">applyCommandLineOptions</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/PublicMethodsCliObjectFactory.html?is-external=true#buildObject-org.apache.commons.cli.CommandLine-" title="class or interface in gobblin.runtime.cli">buildObject</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/PublicMethodsCliObjectFactory.html?is-external=true#buildObject-java.lang.String:A-int-boolean-java.lang.String-" title="class or interface in gobblin.runtime.cli">buildObject</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/PublicMethodsCliObjectFactory.html?is-external=true#getUsageString--" title="class or interface in gobblin.runtime.cli">getUsageString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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&nbsp;gobblin.runtime.cli.<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectFactory.html?is-external=true" title="class or interface in gobblin.runtime.cli">CliObjectFactory</a></h3>
<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectFactory.html?is-external=true#buildObject-org.apache.commons.cli.CommandLine-" title="class or interface in gobblin.runtime.cli">buildObject</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectFactory.html?is-external=true#buildObject-java.lang.String:A-int-boolean-java.lang.String-" title="class or interface in gobblin.runtime.cli">buildObject</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectFactory.html?is-external=true#getOptions--" title="class or interface in gobblin.runtime.cli">getOptions</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/runtime/cli/CliObjectFactory.html?is-external=true#getUsageString--" title="class or interface in gobblin.runtime.cli">getUsageString</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ConstructorAndPublicMethodsGobblinCliFactory-java.lang.Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConstructorAndPublicMethodsGobblinCliFactory</h4>
<pre>public&nbsp;ConstructorAndPublicMethodsGobblinCliFactory(<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>&lt;? extends <a href="../../../gobblin/runtime/embedded/EmbeddedGobblin.html" title="class in gobblin.runtime.embedded">EmbeddedGobblin</a>&gt;&nbsp;klazz)</pre>
</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/CliOptions.html" title="class in gobblin.runtime.cli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/runtime/cli/EmbeddedGobblinCliFactory.html" title="interface in gobblin.runtime.cli"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/runtime/cli/ConstructorAndPublicMethodsGobblinCliFactory.html" target="_top">Frames</a></li>
<li><a href="ConstructorAndPublicMethodsGobblinCliFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.gobblin.runtime.cli.PublicMethodsCliObjectFactory">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.gobblin.runtime.cli.ConstructorAndPublicMethodsCliObjectFactory">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>