http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html b/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html new file mode 100644 index 0000000..9bb6b81 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html @@ -0,0 +1,453 @@ +<!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_91) on Thu Jul 27 17:30:43 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ApplyToActionHandler (Apache OODT 1.2-SNAPSHOT API)</title> +<meta name="date" content="2017-07-27"> +<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="ApplyToActionHandler (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="class-use/ApplyToActionHandler.html">Use</a></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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html" target="_top">Frames</a></li> +<li><a href="ApplyToActionHandler.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>Field | </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>Field | </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">org.apache.oodt.cas.cli.option.handler</div> +<h2 title="Class ApplyToActionHandler" class="title">Class ApplyToActionHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://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>org.apache.oodt.cas.cli.option.handler.ApplyToActionHandler</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ApplyToActionHandler</span> +extends <a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></pre> +<div class="block"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a> which applies <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a> values to + given <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>. If <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a> is a repeating option + then "add<long-name>" is invoked on <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>, otherwise + "set<long-name" is invoked, unless the method name was supplied, then that + method will be invoked.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>bfoster (Brian Foster)</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#ApplyToActionHandler--">ApplyToActionHandler</a></span>()</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="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><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#getApplyToActions--">getApplyToActions</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-">getArgDescription</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">If this handler causes the argument descriptor to be different for + certain <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>s, then should return the arg + description here.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected <a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#getArgDescription-java.lang.String-">getArgDescription</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> actionName)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#getDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-">getDescription</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected <a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#getDescription-java.lang.String-">getDescription</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> actionName)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-">getHelp</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">Gets the <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a>s help message when associated with + given <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>protected <a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#getMethodName-java.lang.String-">getMethodName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> actionName)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#handleOption-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOptionInstance-">handleOption</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> optionInstance)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#initialize-org.apache.oodt.cas.cli.option.CmdLineOption-">initialize</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">Called after handler construction to allow handler to setup + state before it is required to handle the option later.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#setApplyToActions-java.util.List-">setApplyToActions</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a>> applyToActions)</code> </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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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> +</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="ApplyToActionHandler--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ApplyToActionHandler</h4> +<pre>public ApplyToActionHandler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setApplyToActions-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setApplyToActions</h4> +<pre>public void setApplyToActions(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a>> applyToActions)</pre> +</li> +</ul> +<a name="getApplyToActions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getApplyToActions</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a>> getApplyToActions()</pre> +</li> +</ul> +<a name="initialize-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public void initialize(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#initialize-org.apache.oodt.cas.cli.option.CmdLineOption-">CmdLineOptionHandler</a></code></span></div> +<div class="block">Called after handler construction to allow handler to setup + state before it is required to handle the option later. This + is also called when help is run so allows registration to take + place if necessary for help analysis.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#initialize-org.apache.oodt.cas.cli.option.CmdLineOption-">initialize</a></code> in interface <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="handleOption-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOptionInstance-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handleOption</h4> +<pre>public void handleOption(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> optionInstance)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#handleOption-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOptionInstance-">handleOption</a></code> in interface <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="getMethodName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMethodName</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getMethodName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> actionName)</pre> +</li> +</ul> +<a name="getDescription-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDescription</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getDescription(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> actionName)</pre> +</li> +</ul> +<a name="getArgDescription-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArgDescription</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getArgDescription(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> actionName)</pre> +</li> +</ul> +<a name="getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHelp</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getHelp(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-">CmdLineOptionHandler</a></code></span></div> +<div class="block">Gets the <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a>s help message when associated with + given <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-">getHelp</a></code> in interface <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>option</code> - The <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a> to which this + <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a> was associated with</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The help message for this <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a></dd> +</dl> +</li> +</ul> +<a name="getDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDescription</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getDescription(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +</li> +</ul> +<a name="getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getArgDescription</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getArgDescription(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-">CmdLineOptionHandler</a></code></span></div> +<div class="block">If this handler causes the argument descriptor to be different for + certain <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>s, then should return the arg + description here.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-">getArgDescription</a></code> in interface <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></code></dd> +</dl> +</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="class-use/ApplyToActionHandler.html">Use</a></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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html" target="_top">Frames</a></li> +<li><a href="ApplyToActionHandler.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>Field | </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>Field | </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 ======= --> +<p class="legalCopy"><small>Copyright © 1999–2017 <a href="http://oodt.apache.org/";>Apache OODT</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html b/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html new file mode 100644 index 0000000..6865aa0 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html @@ -0,0 +1,302 @@ +<!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_91) on Thu Jul 27 17:30:43 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CmdLineOptionHandler (Apache OODT 1.2-SNAPSHOT API)</title> +<meta name="date" content="2017-07-27"> +<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="CmdLineOptionHandler (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/CmdLineOptionHandler.html">Use</a></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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html" title="class in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html" title="class in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" target="_top">Frames</a></li> +<li><a href="CmdLineOptionHandler.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">org.apache.oodt.cas.cli.option.handler</div> +<h2 title="Interface CmdLineOptionHandler" class="title">Interface CmdLineOptionHandler</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToActionHandler</a>, <a href="../../../../../../../org/apache/oodt/cas/crawl/cli/option/handler/BeanInfoHandler.html" title="class in org.apache.oodt.cas.crawl.cli.option.handler">BeanInfoHandler</a>, <a href="../../../../../../../org/apache/oodt/cas/crawl/cli/option/handler/CrawlerActionInfoHandler.html" title="class in org.apache.oodt.cas.crawl.cli.option.handler">CrawlerActionInfoHandler</a>, <a href="../../../../../../../org/apache/oodt/cas/crawl/cli/option/handler/CrawlerBeansPropHandler.html" title="class in org.apache.oodt.cas.crawl.cli.option.handler">CrawlerBeansPropHandler</a>, <a href="../../../../../../../org/apache/oodt/cas/crawl/cli/option/handler/PreconditionInfoHandler.html" title="class in org.apache.oodt.cas.crawl.cli.option.handler">PreconditionInfoHandler</a>, <a href="../../../../../../../org/apache/oodt /cas/cli/option/handler/SetJavaPropertiesHandler.html" title="class in org.apache.oodt.cas.cli.option.handler">SetJavaPropertiesHandler</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">CmdLineOptionHandler</span></pre> +<div class="block">Handles a <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>'s values in relation to given + <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>s.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>bfoster (Brian Foster)</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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></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><a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-">getArgDescription</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">If this handler causes the argument descriptor to be different for + certain <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>s, then should return the arg + description here.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-">getHelp</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">Gets the <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a>s help message when associated with + given <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#handleOption-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOptionInstance-">handleOption</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> selectedAction, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> optionInstance)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#initialize-org.apache.oodt.cas.cli.option.CmdLineOption-">initialize</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">Called after handler construction to allow handler to setup + state before it is required to handle the option later.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="initialize-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>void initialize(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block">Called after handler construction to allow handler to setup + state before it is required to handle the option later. This + is also called when help is run so allows registration to take + place if necessary for help analysis.</div> +</li> +</ul> +<a name="handleOption-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOptionInstance-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handleOption</h4> +<pre>void handleOption(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> selectedAction, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> optionInstance)</pre> +</li> +</ul> +<a name="getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHelp</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getHelp(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block">Gets the <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a>s help message when associated with + given <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>option</code> - The <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a> to which this + <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a> was associated with</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The help message for this <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a></dd> +</dl> +</li> +</ul> +<a name="getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getArgDescription</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getArgDescription(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block">If this handler causes the argument descriptor to be different for + certain <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>s, then should return the arg + description here.</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="class-use/CmdLineOptionHandler.html">Use</a></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="../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html" title="class in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html" title="class in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" target="_top">Frames</a></li> +<li><a href="CmdLineOptionHandler.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 1999–2017 <a href="http://oodt.apache.org/";>Apache OODT</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html b/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html new file mode 100644 index 0000000..6bbfc32 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html @@ -0,0 +1,397 @@ +<!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_91) on Thu Jul 27 17:30:43 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SetJavaPropertiesHandler (Apache OODT 1.2-SNAPSHOT API)</title> +<meta name="date" content="2017-07-27"> +<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="SetJavaPropertiesHandler (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="class-use/SetJavaPropertiesHandler.html">Use</a></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="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html" target="_top">Frames</a></li> +<li><a href="SetJavaPropertiesHandler.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>Field | </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>Field | </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">org.apache.oodt.cas.cli.option.handler</div> +<h2 title="Class SetJavaPropertiesHandler" class="title">Class SetJavaPropertiesHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://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>org.apache.oodt.cas.cli.option.handler.SetJavaPropertiesHandler</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SetJavaPropertiesHandler</span> +extends <a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></pre> +<div class="block"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a> which sets Java Properties equals to the + values specified by the <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a> this handler is attached + to.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>bfoster (Brian Foster)</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html#SetJavaPropertiesHandler--">SetJavaPropertiesHandler</a></span>()</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="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><a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html#getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-">getArgDescription</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">If this handler causes the argument descriptor to be different for + certain <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>s, then should return the arg + description here.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html#getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-">getHelp</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">Gets the <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a>s help message when associated with + given <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://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="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html#getPropertyNames--">getPropertyNames</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html#handleOption-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOptionInstance-">handleOption</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> selectedAction, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> optionInstance)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html#initialize-org.apache.oodt.cas.cli.option.CmdLineOption-">initialize</a></span>(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</code> +<div class="block">Called after handler construction to allow handler to setup + state before it is required to handle the option later.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html#setPropertyNames-java.util.List-">setPropertyNames</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> propertyNames)</code> </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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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> +</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="SetJavaPropertiesHandler--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SetJavaPropertiesHandler</h4> +<pre>public SetJavaPropertiesHandler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="initialize-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public void initialize(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#initialize-org.apache.oodt.cas.cli.option.CmdLineOption-">CmdLineOptionHandler</a></code></span></div> +<div class="block">Called after handler construction to allow handler to setup + state before it is required to handle the option later. This + is also called when help is run so allows registration to take + place if necessary for help analysis.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#initialize-org.apache.oodt.cas.cli.option.CmdLineOption-">initialize</a></code> in interface <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="handleOption-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOptionInstance-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handleOption</h4> +<pre>public void handleOption(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> selectedAction, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> optionInstance)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#handleOption-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOptionInstance-">handleOption</a></code> in interface <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="setPropertyNames-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertyNames</h4> +<pre>public void setPropertyNames(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> propertyNames)</pre> +</li> +</ul> +<a name="getPropertyNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyNames</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getPropertyNames()</pre> +</li> +</ul> +<a name="getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHelp</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getHelp(<a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-">CmdLineOptionHandler</a></code></span></div> +<div class="block">Gets the <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a>s help message when associated with + given <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getHelp-org.apache.oodt.cas.cli.option.CmdLineOption-">getHelp</a></code> in interface <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>option</code> - The <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a> to which this + <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a> was associated with</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The help message for this <a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><code>CmdLineOptionHandler</code></a></dd> +</dl> +</li> +</ul> +<a name="getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getArgDescription</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getArgDescription(<a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> action, + <a href="../../../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a> option)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-">CmdLineOptionHandler</a></code></span></div> +<div class="block">If this handler causes the argument descriptor to be different for + certain <a href="../../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>s, then should return the arg + description here.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html#getArgDescription-org.apache.oodt.cas.cli.action.CmdLineAction-org.apache.oodt.cas.cli.option.CmdLineOption-">getArgDescription</a></code> in interface <code><a href="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler">CmdLineOptionHandler</a></code></dd> +</dl> +</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="class-use/SetJavaPropertiesHandler.html">Use</a></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="../../../../../../../org/apache/oodt/cas/cli/option/handler/CmdLineOptionHandler.html" title="interface in org.apache.oodt.cas.cli.option.handler"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/oodt/cas/cli/option/handler/SetJavaPropertiesHandler.html" target="_top">Frames</a></li> +<li><a href="SetJavaPropertiesHandler.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>Field | </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>Field | </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 ======= --> +<p class="legalCopy"><small>Copyright © 1999–2017 <a href="http://oodt.apache.org/";>Apache OODT</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/class-use/ApplyToAction.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/class-use/ApplyToAction.html b/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/class-use/ApplyToAction.html new file mode 100644 index 0000000..afd0bc0 --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/cli/option/handler/class-use/ApplyToAction.html @@ -0,0 +1,179 @@ +<!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_91) on Thu Jul 27 17:30:48 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Uses of Class org.apache.oodt.cas.cli.option.handler.ApplyToAction (Apache OODT 1.2-SNAPSHOT API)</title> +<meta name="date" content="2017-07-27"> +<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="Uses of Class org.apache.oodt.cas.cli.option.handler.ApplyToAction (Apache OODT 1.2-SNAPSHOT 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><a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../../index.html?org/apache/oodt/cas/cli/option/handler/class-use/ApplyToAction.html" target="_top">Frames</a></li> +<li><a href="ApplyToAction.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.oodt.cas.cli.option.handler.ApplyToAction" class="title">Uses of Class<br>org.apache.oodt.cas.cli.option.handler.ApplyToAction</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.oodt.cas.cli.option.handler">org.apache.oodt.cas.cli.option.handler</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.oodt.cas.cli.option.handler"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a> in <a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/package-summary.html">org.apache.oodt.cas.cli.option.handler</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/package-summary.html">org.apache.oodt.cas.cli.option.handler</a> that return types with arguments of type <a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a>></code></td> +<td class="colLast"><span class="typeNameLabel">ApplyToActionHandler.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#getApplyToActions--">getApplyToActions</a></span>()</code> </td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/package-summary.html">org.apache.oodt.cas.cli.option.handler</a> with type arguments of type <a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="typeNameLabel">ApplyToActionHandler.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToActionHandler.html#setApplyToActions-java.util.List-">setApplyToActions</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">ApplyToAction</a>> applyToActions)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../../../../org/apache/oodt/cas/cli/option/handler/ApplyToAction.html" title="class in org.apache.oodt.cas.cli.option.handler">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../../index.html?org/apache/oodt/cas/cli/option/handler/class-use/ApplyToAction.html" target="_top">Frames</a></li> +<li><a href="ApplyToAction.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 1999–2017 <a href="http://oodt.apache.org/";>Apache OODT</a>. All rights reserved.</small></p> +</body> +</html>
