diff options
Diffstat (limited to '_released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/cli/CliCommand.html')
| -rw-r--r-- | _released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/cli/CliCommand.html | 511 |
1 files changed, 511 insertions, 0 deletions
diff --git a/_released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/cli/CliCommand.html b/_released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/cli/CliCommand.html new file mode 100644 index 000000000..e285e0d3e --- /dev/null +++ b/_released_docs/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/cli/CliCommand.html @@ -0,0 +1,511 @@ +<!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_352) on Wed Jan 25 17:31:45 CET 2023 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CliCommand (Apache ZooKeeper - Server 3.8.1 API)</title> +<meta name="date" content="2023-01-25"> +<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="CliCommand (Apache ZooKeeper - Server 3.8.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":10,"i8":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CliCommand.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/zookeeper/cli/AddWatchCommand.html" title="class in org.apache.zookeeper.cli"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/zookeeper/cli/CliException.html" title="class in org.apache.zookeeper.cli"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/zookeeper/cli/CliCommand.html" target="_top">Frames</a></li> +<li><a href="CliCommand.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.zookeeper.cli</div> +<h2 title="Class CliCommand" class="title">Class CliCommand</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/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.zookeeper.cli.CliCommand</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/zookeeper/cli/AddAuthCommand.html" title="class in org.apache.zookeeper.cli">AddAuthCommand</a>, <a href="../../../../org/apache/zookeeper/cli/AddWatchCommand.html" title="class in org.apache.zookeeper.cli">AddWatchCommand</a>, <a href="../../../../org/apache/zookeeper/cli/CloseCommand.html" title="class in org.apache.zookeeper.cli">CloseCommand</a>, <a href="../../../../org/apache/zookeeper/cli/CreateCommand.html" title="class in org.apache.zookeeper.cli">CreateCommand</a>, <a href="../../../../org/apache/zookeeper/cli/DeleteAllCommand.html" title="class in org.apache.zookeeper.cli">DeleteAllCommand</a>, <a href="../../../../org/apache/zookeeper/cli/DeleteCommand.html" title="class in org.apache.zookeeper.cli">DeleteCommand</a>, <a href="../../../../org/apache/zookeeper/cli/DelQuotaCommand.html" title="class in org.apache.zookeeper.cli">DelQuotaCommand</a>, <a href="../../../../org/apache/zookeeper/cli/GetAclCommand.html" title="class in org.apache.zookeeper.cli">GetAclCommand</a>, <a href="../../../../org/apache/zookeeper/cli/GetAllChildrenNumberCommand.html" title="class in org.apache.zookeeper.cli">GetAllChildrenNumberCommand</a>, <a href="../../../../org/apache/zookeeper/cli/GetCommand.html" title="class in org.apache.zookeeper.cli">GetCommand</a>, <a href="../../../../org/apache/zookeeper/cli/GetConfigCommand.html" title="class in org.apache.zookeeper.cli">GetConfigCommand</a>, <a href="../../../../org/apache/zookeeper/cli/GetEphemeralsCommand.html" title="class in org.apache.zookeeper.cli">GetEphemeralsCommand</a>, <a href="../../../../org/apache/zookeeper/cli/ListQuotaCommand.html" title="class in org.apache.zookeeper.cli">ListQuotaCommand</a>, <a href="../../../../org/apache/zookeeper/cli/LsCommand.html" title="class in org.apache.zookeeper.cli">LsCommand</a>, <a href="../../../../org/apache/zookeeper/cli/ReconfigCommand.html" title="class in org.apache.zookeeper.cli">ReconfigCommand</a>, <a href="../../../../org/apache/zookeeper/cli/RemoveWatchesCommand.html" title="class in org.apache.zookeeper.cli">RemoveWatchesCommand</a>, <a href="../../../../org/apache/zookeeper/cli/SetAclCommand.html" title="class in org.apache.zookeeper.cli">SetAclCommand</a>, <a href="../../../../org/apache/zookeeper/cli/SetCommand.html" title="class in org.apache.zookeeper.cli">SetCommand</a>, <a href="../../../../org/apache/zookeeper/cli/SetQuotaCommand.html" title="class in org.apache.zookeeper.cli">SetQuotaCommand</a>, <a href="../../../../org/apache/zookeeper/cli/StatCommand.html" title="class in org.apache.zookeeper.cli">StatCommand</a>, <a href="../../../../org/apache/zookeeper/cli/SyncCommand.html" title="class in org.apache.zookeeper.cli">SyncCommand</a>, <a href="../../../../org/apache/zookeeper/cli/VersionCommand.html" title="class in org.apache.zookeeper.cli">VersionCommand</a>, <a href="../../../../org/apache/zookeeper/cli/WhoAmICommand.html" title="class in org.apache.zookeeper.cli">WhoAmICommand</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">CliCommand</span> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">base class for all CLI commands</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/zookeeper/cli/CliCommand.html#err">err</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/zookeeper/cli/CliCommand.html#out">out</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../org/apache/zookeeper/ZooKeeper.html" title="class in org.apache.zookeeper">ZooKeeper</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/zookeeper/cli/CliCommand.html#zk">zk</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/zookeeper/cli/CliCommand.html#CliCommand-java.lang.String-java.lang.String-">CliCommand</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cmdStr, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> optionStr)</code> +<div class="block">a CLI command with command string and options.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/zookeeper/cli/CliCommand.html#addToMap-java.util.Map-">addToMap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/zookeeper/cli/CliCommand.html" title="class in org.apache.zookeeper.cli">CliCommand</a>> cmdMap)</code> +<div class="block">add this command to a map.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/zookeeper/cli/CliCommand.html#exec--">exec</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/zookeeper/cli/CliCommand.html#getCmdStr--">getCmdStr</a></span>()</code> +<div class="block">get the string used to call this command</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/zookeeper/cli/CliCommand.html#getOptionStr--">getOptionStr</a></span>()</code> +<div class="block">get the option string</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/zookeeper/cli/CliCommand.html#getUsageStr--">getUsageStr</a></span>()</code> +<div class="block">get a usage string, contains the command and the options</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../org/apache/zookeeper/cli/CliCommand.html" title="class in org.apache.zookeeper.cli">CliCommand</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/zookeeper/cli/CliCommand.html#parse-java.lang.String:A-">parse</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] cmdArgs)</code> +<div class="block">parse the command arguments</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/zookeeper/cli/CliCommand.html#setErr-java.io.PrintStream-">setErr</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> err)</code> +<div class="block">Set err printStream (usable for testing)</div> +</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/zookeeper/cli/CliCommand.html#setOut-java.io.PrintStream-">setOut</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out)</code> +<div class="block">Set out printStream (usable for testing)</div> +</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/zookeeper/cli/CliCommand.html#setZk-org.apache.zookeeper.ZooKeeper-">setZk</a></span>(<a href="../../../../org/apache/zookeeper/ZooKeeper.html" title="class in org.apache.zookeeper">ZooKeeper</a> zk)</code> +<div class="block">set the zookeeper instance</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="zk"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>zk</h4> +<pre>protected <a href="../../../../org/apache/zookeeper/ZooKeeper.html" title="class in org.apache.zookeeper">ZooKeeper</a> zk</pre> +</li> +</ul> +<a name="out"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>out</h4> +<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out</pre> +</li> +</ul> +<a name="err"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>err</h4> +<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> err</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CliCommand-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CliCommand</h4> +<pre>public CliCommand(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cmdStr, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> optionStr)</pre> +<div class="block">a CLI command with command string and options. + Using System.out and System.err for printing</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdStr</code> - the string used to call this command</dd> +<dd><code>optionStr</code> - the string used to call this command</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setOut-java.io.PrintStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOut</h4> +<pre>public void setOut(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out)</pre> +<div class="block">Set out printStream (usable for testing)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - </dd> +</dl> +</li> +</ul> +<a name="setErr-java.io.PrintStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setErr</h4> +<pre>public void setErr(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> err)</pre> +<div class="block">Set err printStream (usable for testing)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>err</code> - </dd> +</dl> +</li> +</ul> +<a name="setZk-org.apache.zookeeper.ZooKeeper-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setZk</h4> +<pre>public void setZk(<a href="../../../../org/apache/zookeeper/ZooKeeper.html" title="class in org.apache.zookeeper">ZooKeeper</a> zk)</pre> +<div class="block">set the zookeeper instance</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>zk</code> - the ZooKeeper instance.</dd> +</dl> +</li> +</ul> +<a name="getCmdStr--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCmdStr</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCmdStr()</pre> +<div class="block">get the string used to call this command</div> +</li> +</ul> +<a name="getOptionStr--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOptionStr</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOptionStr()</pre> +<div class="block">get the option string</div> +</li> +</ul> +<a name="getUsageStr--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUsageStr</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getUsageStr()</pre> +<div class="block">get a usage string, contains the command and the options</div> +</li> +</ul> +<a name="addToMap-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addToMap</h4> +<pre>public void addToMap(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/zookeeper/cli/CliCommand.html" title="class in org.apache.zookeeper.cli">CliCommand</a>> cmdMap)</pre> +<div class="block">add this command to a map. Use the command string as key.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdMap</code> - </dd> +</dl> +</li> +</ul> +<a name="parse-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public abstract <a href="../../../../org/apache/zookeeper/cli/CliCommand.html" title="class in org.apache.zookeeper.cli">CliCommand</a> parse(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] cmdArgs) + throws <a href="../../../../org/apache/zookeeper/cli/CliParseException.html" title="class in org.apache.zookeeper.cli">CliParseException</a></pre> +<div class="block">parse the command arguments</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cmdArgs</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this CliCommand</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/zookeeper/cli/CliParseException.html" title="class in org.apache.zookeeper.cli">CliParseException</a></code></dd> +</dl> +</li> +</ul> +<a name="exec--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>exec</h4> +<pre>public abstract boolean exec() + throws <a href="../../../../org/apache/zookeeper/cli/CliException.html" title="class in org.apache.zookeeper.cli">CliException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if command has watch option, false otherwise</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/zookeeper/cli/CliException.html" title="class in org.apache.zookeeper.cli">CliException</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/CliCommand.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/zookeeper/cli/AddWatchCommand.html" title="class in org.apache.zookeeper.cli"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/zookeeper/cli/CliException.html" title="class in org.apache.zookeeper.cli"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/zookeeper/cli/CliCommand.html" target="_top">Frames</a></li> +<li><a href="CliCommand.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2008–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |