http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/index.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/index.html b/site_docs/apidocs/index.html new file mode 100644 index 0000000..46ee72d --- /dev/null +++ b/site_docs/apidocs/index.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_91) on Thu Jul 27 17:30:50 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Apache OODT 1.2-SNAPSHOT API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html>
http://git-wip-us.apache.org/repos/asf/oodt/blob/4127d781/site_docs/apidocs/org/apache/oodt/cas/cli/CmdLineArgs.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/cli/CmdLineArgs.html b/site_docs/apidocs/org/apache/oodt/cas/cli/CmdLineArgs.html new file mode 100644 index 0000000..3b588ae --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/cli/CmdLineArgs.html @@ -0,0 +1,355 @@ +<!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:42 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CmdLineArgs (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="CmdLineArgs (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/CmdLineArgs.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>Prev Class</li> +<li><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html" title="class in org.apache.oodt.cas.cli"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/oodt/cas/cli/CmdLineArgs.html" target="_top">Frames</a></li> +<li><a href="CmdLineArgs.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</div> +<h2 title="Class CmdLineArgs" class="title">Class CmdLineArgs</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.CmdLineArgs</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">CmdLineArgs</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></pre> +<div class="block">A convenience class for <a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineUtility</code></a> for helping use already parsed + Command-Line arguments.</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="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="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html#getActionOptionInst--">getActionOptionInst</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html#getHelpOptionInst--">getHelpOptionInst</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html#getPrintSupportedActionsOptionInst--">getPrintSupportedActionsOptionInst</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html#getSpecifiedAction--">getSpecifiedAction</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html#getSpecifiedOptions--">getSpecifiedOptions</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html#getSupportedActions--">getSupportedActions</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html#getSupportedOptions--">getSupportedOptions</a></span>()</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getHelpOptionInst--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHelpOptionInst</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> getHelpOptionInst()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option"><code>CmdLineOptionInstance</code></a> which is the specified + <a href="../../../../../org/apache/oodt/cas/cli/option/HelpCmdLineOption.html" title="class in org.apache.oodt.cas.cli.option"><code>HelpCmdLineOption</code></a>, or null if it was not specified</dd> +</dl> +</li> +</ul> +<a name="getActionOptionInst--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActionOptionInst</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> getActionOptionInst()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option"><code>CmdLineOptionInstance</code></a> which is the specified + <a href="../../../../../org/apache/oodt/cas/cli/option/ActionCmdLineOption.html" title="class in org.apache.oodt.cas.cli.option"><code>ActionCmdLineOption</code></a>, or null if it was not specified</dd> +</dl> +</li> +</ul> +<a name="getPrintSupportedActionsOptionInst--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrintSupportedActionsOptionInst</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a> getPrintSupportedActionsOptionInst()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option"><code>CmdLineOptionInstance</code></a> which is the specified + <a href="../../../../../org/apache/oodt/cas/cli/option/PrintSupportedActionsCmdLineOption.html" title="class in org.apache.oodt.cas.cli.option"><code>PrintSupportedActionsCmdLineOption</code></a>, or null if it was not + specified</dd> +</dl> +</li> +</ul> +<a name="getSupportedOptions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportedOptions</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a>> getSupportedOptions()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>All supported <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>s</dd> +</dl> +</li> +</ul> +<a name="getSpecifiedOptions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSpecifiedOptions</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option">CmdLineOptionInstance</a>> getSpecifiedOptions()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>All specified <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOptionInstance.html" title="class in org.apache.oodt.cas.cli.option"><code>CmdLineOptionInstance</code></a>s</dd> +</dl> +</li> +</ul> +<a name="getSupportedActions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportedActions</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a>> getSupportedActions()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>All supported <a href="../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a>s</dd> +</dl> +</li> +</ul> +<a name="getSpecifiedAction--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSpecifiedAction</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a> getSpecifiedAction()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><code>CmdLineAction</code></a> which was specified</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/CmdLineArgs.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>Prev Class</li> +<li><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html" title="class in org.apache.oodt.cas.cli"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/oodt/cas/cli/CmdLineArgs.html" target="_top">Frames</a></li> +<li><a href="CmdLineArgs.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/CmdLineUtility.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/cli/CmdLineUtility.html b/site_docs/apidocs/org/apache/oodt/cas/cli/CmdLineUtility.html new file mode 100644 index 0000000..b9131df --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/cli/CmdLineUtility.html @@ -0,0 +1,685 @@ +<!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:42 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CmdLineUtility (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="CmdLineUtility (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/CmdLineUtility.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/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><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/CmdLineUtility.html" target="_top">Frames</a></li> +<li><a href="CmdLineUtility.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</div> +<h2 title="Class CmdLineUtility" class="title">Class CmdLineUtility</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.CmdLineUtility</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">CmdLineUtility</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></pre> +<div class="block">A highly configurable utility class which supports parsing and handling of + command line arguments via its action driven design. After parsing the + command line arguments it will check for required arguments not specified, + validate the arguments, run the arguments handlers and then invoke the + specified action. It also supports print out help messages and printing + supported actions.</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/CmdLineUtility.html#CmdLineUtility--">CmdLineUtility</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#check-org.apache.oodt.cas.cli.CmdLineArgs-">check</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> +<div class="block">Checks for required options which are not set and returns the ones it + finds.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#execute-org.apache.oodt.cas.cli.CmdLineArgs-">execute</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> +<div class="block">Checks if required options are set and validation passes, then runs + handlers and executes its action.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/oodt/cas/cli/action/store/CmdLineActionStore.html" title="interface in org.apache.oodt.cas.cli.action.store">CmdLineActionStore</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#getActionStore--">getActionStore</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/oodt/cas/cli/option/store/CmdLineOptionStore.html" title="interface in org.apache.oodt.cas.cli.option.store">CmdLineOptionStore</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#getOptionStore--">getOptionStore</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/oodt/cas/cli/presenter/CmdLinePresenter.html" title="interface in org.apache.oodt.cas.cli.presenter">CmdLinePresenter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#getPresenter--">getPresenter</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/oodt/cas/cli/printer/CmdLinePrinter.html" title="interface in org.apache.oodt.cas.cli.printer">CmdLinePrinter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#getPrinter--">getPrinter</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#handle-org.apache.oodt.cas.cli.CmdLineArgs-">handle</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> +<div class="block">Runs the <code>CmdLineOptionHandler</code>s for <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> given.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#handleHelp-org.apache.oodt.cas.cli.CmdLineArgs-">handleHelp</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> +<div class="block">Checks if help option was specified and if so prints out help.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#handlePrintSupportedActions-org.apache.oodt.cas.cli.CmdLineArgs-">handlePrintSupportedActions</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> +<div class="block">Checks if print supported actions option was specified and if so prints + out supported actions.</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/CmdLineUtility.html#initializeHandlers-java.util.Set-">initializeHandlers</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a>> options)</code> +<div class="block">Initializes each <code>CmdLineOptionHandler</code> with their assigned + <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="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#parse-java.lang.String:A-">parse</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>[] args)</code> +<div class="block">Parses the given command line arguments and converts it to + <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a>.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#printActionHelp-org.apache.oodt.cas.cli.CmdLineArgs-">printActionHelp</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#printActionMessages-java.util.List-">printActionMessages</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>> messages)</code> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#printActionsHelp-org.apache.oodt.cas.cli.CmdLineArgs-">printActionsHelp</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#printErrorMessage-java.lang.String-">printErrorMessage</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> errorMessage)</code> </td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#printMissingRequiredOptionsError-java.util.Set-">printMissingRequiredOptionsError</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a>> missingOptions)</code> </td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#printOptionHelp-org.apache.oodt.cas.cli.CmdLineArgs-">printOptionHelp</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#printValidationErrors-java.util.List-">printValidationErrors</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/validator/CmdLineOptionValidator.Result.html" title="class in org.apache.oodt.cas.cli.option.validator">CmdLineOptionValidator.Result</a>> results)</code> </td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#run-java.lang.String:A-">run</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>[] args)</code> +<div class="block">Parses given command line arguments, then checks for help and print + supported actions options, prints them out if found, otherwise performs + execution on the arguments - see execute(CmdLineArgs).</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#setActionStore-org.apache.oodt.cas.cli.action.store.CmdLineActionStore-">setActionStore</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/action/store/CmdLineActionStore.html" title="interface in org.apache.oodt.cas.cli.action.store">CmdLineActionStore</a> actionStore)</code> </td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#setOptionStore-org.apache.oodt.cas.cli.option.store.CmdLineOptionStore-">setOptionStore</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/option/store/CmdLineOptionStore.html" title="interface in org.apache.oodt.cas.cli.option.store">CmdLineOptionStore</a> optionStore)</code> </td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#setPresenter-org.apache.oodt.cas.cli.presenter.CmdLinePresenter-">setPresenter</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/presenter/CmdLinePresenter.html" title="interface in org.apache.oodt.cas.cli.presenter">CmdLinePresenter</a> presenter)</code> </td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#setPrinter-org.apache.oodt.cas.cli.printer.CmdLinePrinter-">setPrinter</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/printer/CmdLinePrinter.html" title="interface in org.apache.oodt.cas.cli.printer">CmdLinePrinter</a> printer)</code> </td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>static <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/validator/CmdLineOptionValidator.Result.html" title="class in org.apache.oodt.cas.cli.option.validator">CmdLineOptionValidator.Result</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/oodt/cas/cli/CmdLineUtility.html#validate-org.apache.oodt.cas.cli.CmdLineArgs-">validate</a></span>(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</code> +<div class="block">Runs validation on <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> and returns the validation results.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="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="CmdLineUtility--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CmdLineUtility</h4> +<pre>public CmdLineUtility()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getOptionStore--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOptionStore</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/option/store/CmdLineOptionStore.html" title="interface in org.apache.oodt.cas.cli.option.store">CmdLineOptionStore</a> getOptionStore()</pre> +</li> +</ul> +<a name="setOptionStore-org.apache.oodt.cas.cli.option.store.CmdLineOptionStore-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOptionStore</h4> +<pre>public void setOptionStore(<a href="../../../../../org/apache/oodt/cas/cli/option/store/CmdLineOptionStore.html" title="interface in org.apache.oodt.cas.cli.option.store">CmdLineOptionStore</a> optionStore)</pre> +</li> +</ul> +<a name="getActionStore--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActionStore</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/action/store/CmdLineActionStore.html" title="interface in org.apache.oodt.cas.cli.action.store">CmdLineActionStore</a> getActionStore()</pre> +</li> +</ul> +<a name="setActionStore-org.apache.oodt.cas.cli.action.store.CmdLineActionStore-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setActionStore</h4> +<pre>public void setActionStore(<a href="../../../../../org/apache/oodt/cas/cli/action/store/CmdLineActionStore.html" title="interface in org.apache.oodt.cas.cli.action.store">CmdLineActionStore</a> actionStore)</pre> +</li> +</ul> +<a name="getPrinter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrinter</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/printer/CmdLinePrinter.html" title="interface in org.apache.oodt.cas.cli.printer">CmdLinePrinter</a> getPrinter()</pre> +</li> +</ul> +<a name="setPrinter-org.apache.oodt.cas.cli.printer.CmdLinePrinter-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPrinter</h4> +<pre>public void setPrinter(<a href="../../../../../org/apache/oodt/cas/cli/printer/CmdLinePrinter.html" title="interface in org.apache.oodt.cas.cli.printer">CmdLinePrinter</a> printer)</pre> +</li> +</ul> +<a name="getPresenter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPresenter</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/presenter/CmdLinePresenter.html" title="interface in org.apache.oodt.cas.cli.presenter">CmdLinePresenter</a> getPresenter()</pre> +</li> +</ul> +<a name="setPresenter-org.apache.oodt.cas.cli.presenter.CmdLinePresenter-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPresenter</h4> +<pre>public void setPresenter(<a href="../../../../../org/apache/oodt/cas/cli/presenter/CmdLinePresenter.html" title="interface in org.apache.oodt.cas.cli.presenter">CmdLinePresenter</a> presenter)</pre> +</li> +</ul> +<a name="printOptionHelp-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printOptionHelp</h4> +<pre>public void printOptionHelp(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</pre> +</li> +</ul> +<a name="printActionHelp-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printActionHelp</h4> +<pre>public void printActionHelp(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</pre> +</li> +</ul> +<a name="printActionsHelp-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printActionsHelp</h4> +<pre>public void printActionsHelp(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</pre> +</li> +</ul> +<a name="printActionMessages-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printActionMessages</h4> +<pre>public void printActionMessages(<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>> messages)</pre> +</li> +</ul> +<a name="printValidationErrors-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printValidationErrors</h4> +<pre>public void printValidationErrors(<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/validator/CmdLineOptionValidator.Result.html" title="class in org.apache.oodt.cas.cli.option.validator">CmdLineOptionValidator.Result</a>> results)</pre> +</li> +</ul> +<a name="printMissingRequiredOptionsError-java.util.Set-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printMissingRequiredOptionsError</h4> +<pre>public void printMissingRequiredOptionsError(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a>> missingOptions)</pre> +</li> +</ul> +<a name="printErrorMessage-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printErrorMessage</h4> +<pre>public void printErrorMessage(<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> errorMessage)</pre> +</li> +</ul> +<a name="run-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>run</h4> +<pre>public void run(<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>[] args)</pre> +<div class="block">Parses given command line arguments, then checks for help and print + supported actions options, prints them out if found, otherwise performs + execution on the arguments - see execute(CmdLineArgs).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - The who will be parsed and executed.</dd> +</dl> +</li> +</ul> +<a name="parse-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> parse(<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>[] args) + throws <a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineActionStoreException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineActionStoreException</a>, + <a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineConstructionException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineConstructionException</a></pre> +<div class="block">Parses the given command line arguments and converts it to + <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - The command line arguments to parse.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed command line arguments in <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> form.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>IOException</code> - On error parsing command line arguments.</dd> +<dd><code><a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineConstructionException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineConstructionException</a></code> - On error constructing command line arguments.</dd> +<dd><code><a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineOptionStoreException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineOptionStoreException</a></code></dd> +<dd><code><a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineActionStoreException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineActionStoreException</a></code></dd> +</dl> +</li> +</ul> +<a name="initializeHandlers-java.util.Set-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initializeHandlers</h4> +<pre>public void initializeHandlers(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a>> options)</pre> +<div class="block">Initializes each <code>CmdLineOptionHandler</code> with their assigned + <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>options</code> - </dd> +</dl> +</li> +</ul> +<a name="handleHelp-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handleHelp</h4> +<pre>public boolean handleHelp(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</pre> +<div class="block">Checks if help option was specified and if so prints out help.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdLineArgs</code> - The <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> which will be checked for help option</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>True if help was printed, false otherwise</dd> +</dl> +</li> +</ul> +<a name="handlePrintSupportedActions-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handlePrintSupportedActions</h4> +<pre>public boolean handlePrintSupportedActions(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</pre> +<div class="block">Checks if print supported actions option was specified and if so prints + out supported actions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdLineArgs</code> - The <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> which will be checked for print + supported action options</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>True if supported actions was printed, false otherwise</dd> +</dl> +</li> +</ul> +<a name="execute-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs) + throws <a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineActionExecutionException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineActionExecutionException</a>, + <a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineActionException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineActionException</a></pre> +<div class="block">Checks if required options are set and validation passes, then runs + handlers and executes its action.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdLineArgs</code> - The <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> for which execution processing will be + run.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineActionExecutionException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineActionExecutionException</a></code></dd> +<dd><code><a href="../../../../../org/apache/oodt/cas/cli/exception/CmdLineActionException.html" title="class in org.apache.oodt.cas.cli.exception">CmdLineActionException</a></code></dd> +</dl> +</li> +</ul> +<a name="check-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>check</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option">CmdLineOption</a>> check(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</pre> +<div class="block">Checks for required options which are not set and returns the ones it + finds.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdLineArgs</code> - The <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> which will be check for required + options.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The required <a href="../../../../../org/apache/oodt/cas/cli/option/CmdLineOption.html" title="interface in org.apache.oodt.cas.cli.option"><code>CmdLineOption</code></a>s not specified.</dd> +</dl> +</li> +</ul> +<a name="validate-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validate</h4> +<pre>public static <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/validator/CmdLineOptionValidator.Result.html" title="class in org.apache.oodt.cas.cli.option.validator">CmdLineOptionValidator.Result</a>> validate(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</pre> +<div class="block">Runs validation on <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> and returns the validation results.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdLineArgs</code> - The <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> which will be validated.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <code>CmdLineOptionValidator.Result</code>s generated when running + <a href="../../../../../org/apache/oodt/cas/cli/option/validator/CmdLineOptionValidator.html" title="interface in org.apache.oodt.cas.cli.option.validator"><code>CmdLineOptionValidator</code></a>s.</dd> +</dl> +</li> +</ul> +<a name="handle-org.apache.oodt.cas.cli.CmdLineArgs-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>handle</h4> +<pre>public static void handle(<a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli">CmdLineArgs</a> cmdLineArgs)</pre> +<div class="block">Runs the <code>CmdLineOptionHandler</code>s for <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> given.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdLineArgs</code> - The <a href="../../../../../org/apache/oodt/cas/cli/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><code>CmdLineArgs</code></a> whose option handlers will be run.</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/CmdLineUtility.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/CmdLineArgs.html" title="class in org.apache.oodt.cas.cli"><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/CmdLineUtility.html" target="_top">Frames</a></li> +<li><a href="CmdLineUtility.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/action/CmdLineAction.ActionMessagePrinter.html ---------------------------------------------------------------------- diff --git a/site_docs/apidocs/org/apache/oodt/cas/cli/action/CmdLineAction.ActionMessagePrinter.html b/site_docs/apidocs/org/apache/oodt/cas/cli/action/CmdLineAction.ActionMessagePrinter.html new file mode 100644 index 0000000..43569bf --- /dev/null +++ b/site_docs/apidocs/org/apache/oodt/cas/cli/action/CmdLineAction.ActionMessagePrinter.html @@ -0,0 +1,316 @@ +<!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:42 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CmdLineAction.ActionMessagePrinter (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="CmdLineAction.ActionMessagePrinter (Apache OODT 1.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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/CmdLineAction.ActionMessagePrinter.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/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/oodt/cas/cli/action/PrintMessageAction.html" title="class in org.apache.oodt.cas.cli.action"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/oodt/cas/cli/action/CmdLineAction.ActionMessagePrinter.html" target="_top">Frames</a></li> +<li><a href="CmdLineAction.ActionMessagePrinter.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.action</div> +<h2 title="Class CmdLineAction.ActionMessagePrinter" class="title">Class CmdLineAction.ActionMessagePrinter</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.action.CmdLineAction.ActionMessagePrinter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action">CmdLineAction</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">CmdLineAction.ActionMessagePrinter</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></pre> +</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/action/CmdLineAction.ActionMessagePrinter.html#ActionMessagePrinter--">ActionMessagePrinter</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="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/action/CmdLineAction.ActionMessagePrinter.html#getPrintedMessages--">getPrintedMessages</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/oodt/cas/cli/action/CmdLineAction.ActionMessagePrinter.html#print-java.lang.String-">print</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> message)</code> </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/action/CmdLineAction.ActionMessagePrinter.html#println--">println</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/action/CmdLineAction.ActionMessagePrinter.html#println-java.lang.String-">println</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> message)</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="ActionMessagePrinter--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ActionMessagePrinter</h4> +<pre>public ActionMessagePrinter()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="print-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>print</h4> +<pre>public void print(<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> message)</pre> +</li> +</ul> +<a name="println-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>println</h4> +<pre>public void println(<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> message)</pre> +</li> +</ul> +<a name="println--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>println</h4> +<pre>public void println()</pre> +</li> +</ul> +<a name="getPrintedMessages--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPrintedMessages</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>> getPrintedMessages()</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="class-use/CmdLineAction.ActionMessagePrinter.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/action/CmdLineAction.html" title="class in org.apache.oodt.cas.cli.action"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/oodt/cas/cli/action/PrintMessageAction.html" title="class in org.apache.oodt.cas.cli.action"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/oodt/cas/cli/action/CmdLineAction.ActionMessagePrinter.html" target="_top">Frames</a></li> +<li><a href="CmdLineAction.ActionMessagePrinter.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>
