(DEPLOYED ACF) Updated JavaDocs

This commit is contained in:
Aikar
2019-02-25 22:47:25 -05:00
parent 6a7766e35d
commit 9cff04301f
2 changed files with 56 additions and 55 deletions
@@ -208,7 +208,7 @@ extends <a href="../../../co/aikar/commands/BaseCommand.html" title="class in co
<ul class="blockList">
<li class="blockList">
<h4>getRegisteredCommands</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../co/aikar/commands/RegisteredCommand.html" title="class in co.aikar.commands">RegisteredCommand</a>&gt;&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.46">getRegisteredCommands</a>()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../co/aikar/commands/RegisteredCommand.html" title="class in co.aikar.commands">RegisteredCommand</a>&gt;&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.47">getRegisteredCommands</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../co/aikar/commands/BaseCommand.html#getRegisteredCommands--">getRegisteredCommands</a></code>&nbsp;in class&nbsp;<code><a href="../../../co/aikar/commands/BaseCommand.html" title="class in co.aikar.commands">BaseCommand</a></code></dd>
@@ -221,7 +221,7 @@ extends <a href="../../../co/aikar/commands/BaseCommand.html" title="class in co
<ul class="blockList">
<li class="blockList">
<h4>getLastCommandOperationContext</h4>
<pre>public&nbsp;<a href="../../../co/aikar/commands/CommandOperationContext.html" title="class in co.aikar.commands">CommandOperationContext</a>&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.51">getLastCommandOperationContext</a>()</pre>
<pre>public&nbsp;<a href="../../../co/aikar/commands/CommandOperationContext.html" title="class in co.aikar.commands">CommandOperationContext</a>&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.52">getLastCommandOperationContext</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../co/aikar/commands/BaseCommand.html#getLastCommandOperationContext--">BaseCommand</a></code></span></div>
<div class="block">Returns a reference to the last used CommandOperationContext.
This method is ThreadLocal, in that it can only be used on a thread that has executed a command</div>
@@ -238,7 +238,7 @@ extends <a href="../../../co/aikar/commands/BaseCommand.html" title="class in co
<ul class="blockList">
<li class="blockList">
<h4>getRequiredPermissions</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.56">getRequiredPermissions</a>()</pre>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.57">getRequiredPermissions</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../co/aikar/commands/BaseCommand.html#getRequiredPermissions--">getRequiredPermissions</a></code>&nbsp;in class&nbsp;<code><a href="../../../co/aikar/commands/BaseCommand.html" title="class in co.aikar.commands">BaseCommand</a></code></dd>
@@ -251,7 +251,7 @@ extends <a href="../../../co/aikar/commands/BaseCommand.html" title="class in co
<ul class="blockList">
<li class="blockList">
<h4>hasPermission</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.61">hasPermission</a>(<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>&nbsp;issuer)</pre>
<pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.62">hasPermission</a>(<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>&nbsp;issuer)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../co/aikar/commands/BaseCommand.html#hasPermission-java.lang.Object-">hasPermission</a></code>&nbsp;in class&nbsp;<code><a href="../../../co/aikar/commands/BaseCommand.html" title="class in co.aikar.commands">BaseCommand</a></code></dd>
@@ -264,7 +264,7 @@ extends <a href="../../../co/aikar/commands/BaseCommand.html" title="class in co
<ul class="blockList">
<li class="blockList">
<h4>requiresPermission</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.66">requiresPermission</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>&nbsp;permission)</pre>
<pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.67">requiresPermission</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>&nbsp;permission)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../co/aikar/commands/BaseCommand.html#requiresPermission-java.lang.String-">requiresPermission</a></code>&nbsp;in class&nbsp;<code><a href="../../../co/aikar/commands/BaseCommand.html" title="class in co.aikar.commands">BaseCommand</a></code></dd>
@@ -277,7 +277,7 @@ extends <a href="../../../co/aikar/commands/BaseCommand.html" title="class in co
<ul class="blockList">
<li class="blockList">
<h4>hasPermission</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.71">hasPermission</a>(<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a>&nbsp;sender)</pre>
<pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.72">hasPermission</a>(<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a>&nbsp;sender)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../co/aikar/commands/BaseCommand.html#hasPermission-co.aikar.commands.CommandIssuer-">hasPermission</a></code>&nbsp;in class&nbsp;<code><a href="../../../co/aikar/commands/BaseCommand.html" title="class in co.aikar.commands">BaseCommand</a></code></dd>
@@ -290,7 +290,7 @@ extends <a href="../../../co/aikar/commands/BaseCommand.html" title="class in co
<ul class="blockList">
<li class="blockList">
<h4>tabComplete</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.76">tabComplete</a>(<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a>&nbsp;issuer,
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.77">tabComplete</a>(<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a>&nbsp;issuer,
<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>&nbsp;alias,
<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>[]&nbsp;args,
boolean&nbsp;isAsync)
@@ -319,7 +319,7 @@ extends <a href="../../../co/aikar/commands/BaseCommand.html" title="class in co
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.81">execute</a>(<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a>&nbsp;issuer,
<pre>public&nbsp;void&nbsp;<a href="../../../src-html/co/aikar/commands/ForwardingCommand.html#line.82">execute</a>(<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a>&nbsp;issuer,
co.aikar.commands.CommandRouter.CommandRouteResult&nbsp;result)</pre>
</li>
</ul>
@@ -48,53 +48,54 @@
<span class="sourceLineNo">040</span> this.command = baseCommand;<a name="line.40"></a>
<span class="sourceLineNo">041</span> this.baseArgs = baseArgs;<a name="line.41"></a>
<span class="sourceLineNo">042</span> this.manager = baseCommand.manager;<a name="line.42"></a>
<span class="sourceLineNo">043</span> }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> @Override<a name="line.45"></a>
<span class="sourceLineNo">046</span> public List&lt;RegisteredCommand&gt; getRegisteredCommands() {<a name="line.46"></a>
<span class="sourceLineNo">047</span> return Collections.singletonList(regCommand);<a name="line.47"></a>
<span class="sourceLineNo">048</span> }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> @Override<a name="line.50"></a>
<span class="sourceLineNo">051</span> public CommandOperationContext getLastCommandOperationContext() {<a name="line.51"></a>
<span class="sourceLineNo">052</span> return command.getLastCommandOperationContext();<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> @Override<a name="line.55"></a>
<span class="sourceLineNo">056</span> public Set&lt;String&gt; getRequiredPermissions() {<a name="line.56"></a>
<span class="sourceLineNo">057</span> return command.getRequiredPermissions();<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> @Override<a name="line.60"></a>
<span class="sourceLineNo">061</span> public boolean hasPermission(Object issuer) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> return command.hasPermission(issuer);<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> @Override<a name="line.65"></a>
<span class="sourceLineNo">066</span> public boolean requiresPermission(String permission) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> return command.requiresPermission(permission);<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> @Override<a name="line.70"></a>
<span class="sourceLineNo">071</span> public boolean hasPermission(CommandIssuer sender) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return command.hasPermission(sender);<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span> public List&lt;String&gt; tabComplete(CommandIssuer issuer, String alias, String[] args, boolean isAsync) throws IllegalArgumentException {<a name="line.76"></a>
<span class="sourceLineNo">077</span> return command.tabComplete(issuer, alias, ApacheCommonsLangUtil.addAll(baseArgs, args), isAsync);<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> @Override<a name="line.80"></a>
<span class="sourceLineNo">081</span> public void execute(CommandIssuer issuer, CommandRouter.CommandRouteResult result) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> result = new CommandRouter.CommandRouteResult(result, ApacheCommonsLangUtil.addAll(baseArgs, result.args));<a name="line.82"></a>
<span class="sourceLineNo">083</span> command.execute(issuer, result);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> BaseCommand getCommand() {<a name="line.86"></a>
<span class="sourceLineNo">087</span> return command;<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span>}<a name="line.89"></a>
<span class="sourceLineNo">043</span> this.subCommands.put(DEFAULT, regCommand);<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> @Override<a name="line.46"></a>
<span class="sourceLineNo">047</span> public List&lt;RegisteredCommand&gt; getRegisteredCommands() {<a name="line.47"></a>
<span class="sourceLineNo">048</span> return Collections.singletonList(regCommand);<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> @Override<a name="line.51"></a>
<span class="sourceLineNo">052</span> public CommandOperationContext getLastCommandOperationContext() {<a name="line.52"></a>
<span class="sourceLineNo">053</span> return command.getLastCommandOperationContext();<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> @Override<a name="line.56"></a>
<span class="sourceLineNo">057</span> public Set&lt;String&gt; getRequiredPermissions() {<a name="line.57"></a>
<span class="sourceLineNo">058</span> return command.getRequiredPermissions();<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> @Override<a name="line.61"></a>
<span class="sourceLineNo">062</span> public boolean hasPermission(Object issuer) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> return command.hasPermission(issuer);<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> @Override<a name="line.66"></a>
<span class="sourceLineNo">067</span> public boolean requiresPermission(String permission) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> return command.requiresPermission(permission);<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> @Override<a name="line.71"></a>
<span class="sourceLineNo">072</span> public boolean hasPermission(CommandIssuer sender) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> return command.hasPermission(sender);<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span> public List&lt;String&gt; tabComplete(CommandIssuer issuer, String alias, String[] args, boolean isAsync) throws IllegalArgumentException {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return command.tabComplete(issuer, alias, ApacheCommonsLangUtil.addAll(baseArgs, args), isAsync);<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public void execute(CommandIssuer issuer, CommandRouter.CommandRouteResult result) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> result = new CommandRouter.CommandRouteResult(regCommand, result.args, ACFUtil.join(baseArgs), result.commandLabel);<a name="line.83"></a>
<span class="sourceLineNo">084</span> command.execute(issuer, result);<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> BaseCommand getCommand() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> return command;<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span>}<a name="line.90"></a>