mirror of
https://github.com/aikar/commands.git
synced 2026-05-31 06:11:55 +00:00
(DEPLOYED ACF) Updated JavaDocs
This commit is contained in:
Aikar
@@ -148,7 +148,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?
|
||||
<tr id="i0" class="altColor">
|
||||
<td class="colFirst"><code><a href="http://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="../../../co/aikar/commands/CommandHelpFormatter.html#getEntryFormatReplacements-co.aikar.commands.CommandHelp-co.aikar.commands.HelpEntry-">getEntryFormatReplacements</a></span>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> e)</code>
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</code>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -162,7 +162,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?
|
||||
<td class="colFirst"><code>@NotNull <a href="http://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="../../../co/aikar/commands/CommandHelpFormatter.html#getParameterFormatReplacements-co.aikar.commands.CommandHelp-co.aikar.commands.CommandParameter-co.aikar.commands.HelpEntry-">getParameterFormatReplacements</a></span>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../co/aikar/commands/CommandParameter.html" title="class in co.aikar.commands">CommandParameter</a> param,
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> page)</code>
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</code>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -341,7 +341,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>printDetailedHelpCommand</h4>
|
||||
<pre>public void <a href="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.92">printDetailedHelpCommand</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<pre>public void <a href="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.93">printDetailedHelpCommand</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a> issuer,
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</pre>
|
||||
</li>
|
||||
@@ -352,7 +352,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>printDetailedParameter</h4>
|
||||
<pre>public void <a href="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.99">printDetailedParameter</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<pre>public void <a href="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.100">printDetailedParameter</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a> issuer,
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry,
|
||||
<a href="../../../co/aikar/commands/CommandParameter.html" title="class in co.aikar.commands">CommandParameter</a> param)</pre>
|
||||
@@ -364,7 +364,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>printDetailedHelpFooter</h4>
|
||||
<pre>public void <a href="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.106">printDetailedHelpFooter</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<pre>public void <a href="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.107">printDetailedHelpFooter</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../co/aikar/commands/CommandIssuer.html" title="interface in co.aikar.commands">CommandIssuer</a> issuer,
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</pre>
|
||||
</li>
|
||||
@@ -375,7 +375,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>getHeaderFooterFormatReplacements</h4>
|
||||
<pre>public <a href="http://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="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.116">getHeaderFooterFormatReplacements</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help)</pre>
|
||||
<pre>public <a href="http://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="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.117">getHeaderFooterFormatReplacements</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help)</pre>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
<dl>
|
||||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||||
@@ -390,13 +390,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>getEntryFormatReplacements</h4>
|
||||
<pre>public <a href="http://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="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.134">getEntryFormatReplacements</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> e)</pre>
|
||||
<pre>public <a href="http://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="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.136">getEntryFormatReplacements</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</pre>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
<dl>
|
||||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||||
<dd><code>help</code> - </dd>
|
||||
<dd><code>e</code> - </dd>
|
||||
<dd><code>entry</code> - </dd>
|
||||
<dt><span class="returnLabel">Returns:</span></dt>
|
||||
</dl>
|
||||
</li>
|
||||
@@ -408,15 +408,15 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?
|
||||
<li class="blockList">
|
||||
<h4>getParameterFormatReplacements</h4>
|
||||
<pre>@NotNull
|
||||
public @NotNull <a href="http://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="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.154">getParameterFormatReplacements</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
public @NotNull <a href="http://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="../../../src-html/co/aikar/commands/CommandHelpFormatter.html#line.156">getParameterFormatReplacements</a>(<a href="../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../co/aikar/commands/CommandParameter.html" title="class in co.aikar.commands">CommandParameter</a> param,
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> page)</pre>
|
||||
<a href="../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</pre>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
<dl>
|
||||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||||
<dd><code>help</code> - </dd>
|
||||
<dd><code>param</code> - </dd>
|
||||
<dd><code>page</code> - </dd>
|
||||
<dd><code>entry</code> - </dd>
|
||||
<dt><span class="returnLabel">Returns:</span></dt>
|
||||
</dl>
|
||||
</li>
|
||||
|
||||
@@ -155,7 +155,7 @@
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code><a href="http://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"><span class="typeNameLabel">CommandHelpFormatter.</span><code><span class="memberNameLink"><a href="../../../../co/aikar/commands/CommandHelpFormatter.html#getEntryFormatReplacements-co.aikar.commands.CommandHelp-co.aikar.commands.HelpEntry-">getEntryFormatReplacements</a></span>(<a href="../../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> e)</code>
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</code>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -169,7 +169,7 @@
|
||||
<td class="colFirst"><code>@NotNull <a href="http://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"><span class="typeNameLabel">CommandHelpFormatter.</span><code><span class="memberNameLink"><a href="../../../../co/aikar/commands/CommandHelpFormatter.html#getParameterFormatReplacements-co.aikar.commands.CommandHelp-co.aikar.commands.CommandParameter-co.aikar.commands.HelpEntry-">getParameterFormatReplacements</a></span>(<a href="../../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../../co/aikar/commands/CommandParameter.html" title="class in co.aikar.commands">CommandParameter</a> param,
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> page)</code>
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</code>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -127,7 +127,7 @@
|
||||
<td class="colFirst"><code>@NotNull <a href="http://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"><span class="typeNameLabel">CommandHelpFormatter.</span><code><span class="memberNameLink"><a href="../../../../co/aikar/commands/CommandHelpFormatter.html#getParameterFormatReplacements-co.aikar.commands.CommandHelp-co.aikar.commands.CommandParameter-co.aikar.commands.HelpEntry-">getParameterFormatReplacements</a></span>(<a href="../../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../../co/aikar/commands/CommandParameter.html" title="class in co.aikar.commands">CommandParameter</a> param,
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> page)</code>
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</code>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -130,7 +130,7 @@
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code><a href="http://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"><span class="typeNameLabel">CommandHelpFormatter.</span><code><span class="memberNameLink"><a href="../../../../co/aikar/commands/CommandHelpFormatter.html#getEntryFormatReplacements-co.aikar.commands.CommandHelp-co.aikar.commands.HelpEntry-">getEntryFormatReplacements</a></span>(<a href="../../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> e)</code>
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</code>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -138,7 +138,7 @@
|
||||
<td class="colFirst"><code>@NotNull <a href="http://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"><span class="typeNameLabel">CommandHelpFormatter.</span><code><span class="memberNameLink"><a href="../../../../co/aikar/commands/CommandHelpFormatter.html#getParameterFormatReplacements-co.aikar.commands.CommandHelp-co.aikar.commands.CommandParameter-co.aikar.commands.HelpEntry-">getParameterFormatReplacements</a></span>(<a href="../../../../co/aikar/commands/CommandHelp.html" title="class in co.aikar.commands">CommandHelp</a> help,
|
||||
<a href="../../../../co/aikar/commands/CommandParameter.html" title="class in co.aikar.commands">CommandParameter</a> param,
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> page)</code>
|
||||
<a href="../../../../co/aikar/commands/HelpEntry.html" title="class in co.aikar.commands">HelpEntry</a> entry)</code>
|
||||
<div class="block">Override this to control replacements</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -61,7 +61,7 @@
|
||||
<span class="sourceLineNo">053</span> this.issuer = issuer;<a name="line.53"></a>
|
||||
<span class="sourceLineNo">054</span> this.perPage = manager.defaultHelpPerPage;<a name="line.54"></a>
|
||||
<span class="sourceLineNo">055</span> this.commandPrefix = manager.getCommandPrefix(issuer);<a name="line.55"></a>
|
||||
<span class="sourceLineNo">056</span> this.commandName = this.commandPrefix + rootCommand.getCommandName();<a name="line.56"></a>
|
||||
<span class="sourceLineNo">056</span> this.commandName = rootCommand.getCommandName();<a name="line.56"></a>
|
||||
<span class="sourceLineNo">057</span><a name="line.57"></a>
|
||||
<span class="sourceLineNo">058</span><a name="line.58"></a>
|
||||
<span class="sourceLineNo">059</span> SetMultimap<String, RegisteredCommand> subCommands = rootCommand.getSubCommands();<a name="line.59"></a>
|
||||
|
||||
@@ -92,84 +92,87 @@
|
||||
<span class="sourceLineNo">084</span><a name="line.84"></a>
|
||||
<span class="sourceLineNo">085</span> public void printDetailedHelpHeader(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {<a name="line.85"></a>
|
||||
<span class="sourceLineNo">086</span> issuer.sendMessage(MessageType.HELP, MessageKeys.HELP_DETAILED_HEADER,<a name="line.86"></a>
|
||||
<span class="sourceLineNo">087</span> "{command}", entry.getCommand()<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">090</span><a name="line.90"></a>
|
||||
<span class="sourceLineNo">087</span> "{command}", entry.getCommand(),<a name="line.87"></a>
|
||||
<span class="sourceLineNo">088</span> "{commandprefix}", help.getCommandPrefix()<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>
|
||||
<span class="sourceLineNo">091</span><a name="line.91"></a>
|
||||
<span class="sourceLineNo">092</span> public void printDetailedHelpCommand(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {<a name="line.92"></a>
|
||||
<span class="sourceLineNo">093</span> String formatted = this.manager.formatMessage(issuer, MessageType.HELP, MessageKeys.HELP_DETAILED_COMMAND_FORMAT, getEntryFormatReplacements(help, entry));<a name="line.93"></a>
|
||||
<span class="sourceLineNo">094</span> for (String msg : ACFPatterns.NEWLINE.split(formatted)) {<a name="line.94"></a>
|
||||
<span class="sourceLineNo">095</span> issuer.sendMessageInternal(ACFUtil.rtrim(msg));<a name="line.95"></a>
|
||||
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
|
||||
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
|
||||
<span class="sourceLineNo">098</span><a name="line.98"></a>
|
||||
<span class="sourceLineNo">099</span> public void printDetailedParameter(CommandHelp help, CommandIssuer issuer, HelpEntry entry, CommandParameter param) {<a name="line.99"></a>
|
||||
<span class="sourceLineNo">100</span> String formattedMsg = this.manager.formatMessage(issuer, MessageType.HELP, MessageKeys.HELP_DETAILED_PARAMETER_FORMAT, getParameterFormatReplacements(help, param, entry));<a name="line.100"></a>
|
||||
<span class="sourceLineNo">101</span> for (String msg : ACFPatterns.NEWLINE.split(formattedMsg)) {<a name="line.101"></a>
|
||||
<span class="sourceLineNo">102</span> issuer.sendMessageInternal(ACFUtil.rtrim(msg));<a name="line.102"></a>
|
||||
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
|
||||
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
|
||||
<span class="sourceLineNo">105</span><a name="line.105"></a>
|
||||
<span class="sourceLineNo">106</span> public void printDetailedHelpFooter(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {<a name="line.106"></a>
|
||||
<span class="sourceLineNo">107</span> // default doesn't have a footer<a name="line.107"></a>
|
||||
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
|
||||
<span class="sourceLineNo">109</span><a name="line.109"></a>
|
||||
<span class="sourceLineNo">110</span> /**<a name="line.110"></a>
|
||||
<span class="sourceLineNo">111</span> * Override this to control replacements<a name="line.111"></a>
|
||||
<span class="sourceLineNo">112</span> *<a name="line.112"></a>
|
||||
<span class="sourceLineNo">113</span> * @param help<a name="line.113"></a>
|
||||
<span class="sourceLineNo">114</span> * @return<a name="line.114"></a>
|
||||
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
|
||||
<span class="sourceLineNo">116</span> public String[] getHeaderFooterFormatReplacements(CommandHelp help) {<a name="line.116"></a>
|
||||
<span class="sourceLineNo">117</span> return new String[]{<a name="line.117"></a>
|
||||
<span class="sourceLineNo">118</span> "{search}", help.search != null ? String.join(" ", help.search) : "",<a name="line.118"></a>
|
||||
<span class="sourceLineNo">119</span> "{command}", help.getCommandName(),<a name="line.119"></a>
|
||||
<span class="sourceLineNo">120</span> "{rootcommand}", help.getCommandName(),<a name="line.120"></a>
|
||||
<span class="sourceLineNo">121</span> "{page}", "" + help.getPage(),<a name="line.121"></a>
|
||||
<span class="sourceLineNo">122</span> "{totalpages}", "" + help.getTotalPages(),<a name="line.122"></a>
|
||||
<span class="sourceLineNo">123</span> "{results}", "" + help.getTotalResults()<a name="line.123"></a>
|
||||
<span class="sourceLineNo">124</span> };<a name="line.124"></a>
|
||||
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
|
||||
<span class="sourceLineNo">126</span><a name="line.126"></a>
|
||||
<span class="sourceLineNo">127</span> /**<a name="line.127"></a>
|
||||
<span class="sourceLineNo">128</span> * Override this to control replacements<a name="line.128"></a>
|
||||
<span class="sourceLineNo">129</span> *<a name="line.129"></a>
|
||||
<span class="sourceLineNo">130</span> * @param help<a name="line.130"></a>
|
||||
<span class="sourceLineNo">131</span> * @param e<a name="line.131"></a>
|
||||
<span class="sourceLineNo">132</span> * @return<a name="line.132"></a>
|
||||
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
|
||||
<span class="sourceLineNo">134</span> public String[] getEntryFormatReplacements(CommandHelp help, HelpEntry e) {<a name="line.134"></a>
|
||||
<span class="sourceLineNo">135</span> //{command} {parameters} {separator} {description}<a name="line.135"></a>
|
||||
<span class="sourceLineNo">136</span> return new String[]{<a name="line.136"></a>
|
||||
<span class="sourceLineNo">137</span> "{command}", e.getCommand(),<a name="line.137"></a>
|
||||
<span class="sourceLineNo">138</span> "{rootcommand}", help.getCommandName(),<a name="line.138"></a>
|
||||
<span class="sourceLineNo">139</span> "{parameters}", e.getParameterSyntax(),<a name="line.139"></a>
|
||||
<span class="sourceLineNo">140</span> "{separator}", e.getDescription().isEmpty() ? "" : "-",<a name="line.140"></a>
|
||||
<span class="sourceLineNo">141</span> "{description}", e.getDescription()<a name="line.141"></a>
|
||||
<span class="sourceLineNo">142</span> };<a name="line.142"></a>
|
||||
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
|
||||
<span class="sourceLineNo">144</span><a name="line.144"></a>
|
||||
<span class="sourceLineNo">145</span> /**<a name="line.145"></a>
|
||||
<span class="sourceLineNo">146</span> * Override this to control replacements<a name="line.146"></a>
|
||||
<span class="sourceLineNo">147</span> *<a name="line.147"></a>
|
||||
<span class="sourceLineNo">148</span> * @param help<a name="line.148"></a>
|
||||
<span class="sourceLineNo">149</span> * @param param<a name="line.149"></a>
|
||||
<span class="sourceLineNo">150</span> * @param page<a name="line.150"></a>
|
||||
<span class="sourceLineNo">151</span> * @return<a name="line.151"></a>
|
||||
<span class="sourceLineNo">152</span> */<a name="line.152"></a>
|
||||
<span class="sourceLineNo">153</span> @NotNull<a name="line.153"></a>
|
||||
<span class="sourceLineNo">154</span> public String[] getParameterFormatReplacements(CommandHelp help, CommandParameter param, HelpEntry page) {<a name="line.154"></a>
|
||||
<span class="sourceLineNo">155</span> //{name} {description}<a name="line.155"></a>
|
||||
<span class="sourceLineNo">156</span> return new String[]{<a name="line.156"></a>
|
||||
<span class="sourceLineNo">157</span> "{name}", param.getName(),<a name="line.157"></a>
|
||||
<span class="sourceLineNo">158</span> "{syntax}", ACFUtil.nullDefault(param.getSyntax(), ""),<a name="line.158"></a>
|
||||
<span class="sourceLineNo">159</span> "{description}", ACFUtil.nullDefault(param.getDescription(), ""),<a name="line.159"></a>
|
||||
<span class="sourceLineNo">160</span> "{command}", page.getCommand(),<a name="line.160"></a>
|
||||
<span class="sourceLineNo">161</span> "{rootcommand}", help.getCommandName()<a name="line.161"></a>
|
||||
<span class="sourceLineNo">162</span> };<a name="line.162"></a>
|
||||
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
|
||||
<span class="sourceLineNo">164</span>}<a name="line.164"></a>
|
||||
<span class="sourceLineNo">092</span><a name="line.92"></a>
|
||||
<span class="sourceLineNo">093</span> public void printDetailedHelpCommand(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {<a name="line.93"></a>
|
||||
<span class="sourceLineNo">094</span> String formatted = this.manager.formatMessage(issuer, MessageType.HELP, MessageKeys.HELP_DETAILED_COMMAND_FORMAT, getEntryFormatReplacements(help, entry));<a name="line.94"></a>
|
||||
<span class="sourceLineNo">095</span> for (String msg : ACFPatterns.NEWLINE.split(formatted)) {<a name="line.95"></a>
|
||||
<span class="sourceLineNo">096</span> issuer.sendMessageInternal(ACFUtil.rtrim(msg));<a name="line.96"></a>
|
||||
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
|
||||
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
|
||||
<span class="sourceLineNo">099</span><a name="line.99"></a>
|
||||
<span class="sourceLineNo">100</span> public void printDetailedParameter(CommandHelp help, CommandIssuer issuer, HelpEntry entry, CommandParameter param) {<a name="line.100"></a>
|
||||
<span class="sourceLineNo">101</span> String formattedMsg = this.manager.formatMessage(issuer, MessageType.HELP, MessageKeys.HELP_DETAILED_PARAMETER_FORMAT, getParameterFormatReplacements(help, param, entry));<a name="line.101"></a>
|
||||
<span class="sourceLineNo">102</span> for (String msg : ACFPatterns.NEWLINE.split(formattedMsg)) {<a name="line.102"></a>
|
||||
<span class="sourceLineNo">103</span> issuer.sendMessageInternal(ACFUtil.rtrim(msg));<a name="line.103"></a>
|
||||
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
|
||||
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
|
||||
<span class="sourceLineNo">106</span><a name="line.106"></a>
|
||||
<span class="sourceLineNo">107</span> public void printDetailedHelpFooter(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {<a name="line.107"></a>
|
||||
<span class="sourceLineNo">108</span> // default doesn't have a footer<a name="line.108"></a>
|
||||
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
|
||||
<span class="sourceLineNo">110</span><a name="line.110"></a>
|
||||
<span class="sourceLineNo">111</span> /**<a name="line.111"></a>
|
||||
<span class="sourceLineNo">112</span> * Override this to control replacements<a name="line.112"></a>
|
||||
<span class="sourceLineNo">113</span> *<a name="line.113"></a>
|
||||
<span class="sourceLineNo">114</span> * @param help<a name="line.114"></a>
|
||||
<span class="sourceLineNo">115</span> * @return<a name="line.115"></a>
|
||||
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
|
||||
<span class="sourceLineNo">117</span> public String[] getHeaderFooterFormatReplacements(CommandHelp help) {<a name="line.117"></a>
|
||||
<span class="sourceLineNo">118</span> return new String[]{<a name="line.118"></a>
|
||||
<span class="sourceLineNo">119</span> "{search}", help.search != null ? String.join(" ", help.search) : "",<a name="line.119"></a>
|
||||
<span class="sourceLineNo">120</span> "{command}", help.getCommandName(),<a name="line.120"></a>
|
||||
<span class="sourceLineNo">121</span> "{commandprefix}", help.getCommandPrefix(),<a name="line.121"></a>
|
||||
<span class="sourceLineNo">122</span> "{rootcommand}", help.getCommandName(),<a name="line.122"></a>
|
||||
<span class="sourceLineNo">123</span> "{page}", "" + help.getPage(),<a name="line.123"></a>
|
||||
<span class="sourceLineNo">124</span> "{totalpages}", "" + help.getTotalPages(),<a name="line.124"></a>
|
||||
<span class="sourceLineNo">125</span> "{results}", "" + help.getTotalResults()<a name="line.125"></a>
|
||||
<span class="sourceLineNo">126</span> };<a name="line.126"></a>
|
||||
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
|
||||
<span class="sourceLineNo">128</span><a name="line.128"></a>
|
||||
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
|
||||
<span class="sourceLineNo">130</span> * Override this to control replacements<a name="line.130"></a>
|
||||
<span class="sourceLineNo">131</span> *<a name="line.131"></a>
|
||||
<span class="sourceLineNo">132</span> * @param help<a name="line.132"></a>
|
||||
<span class="sourceLineNo">133</span> * @param entry<a name="line.133"></a>
|
||||
<span class="sourceLineNo">134</span> * @return<a name="line.134"></a>
|
||||
<span class="sourceLineNo">135</span> */<a name="line.135"></a>
|
||||
<span class="sourceLineNo">136</span> public String[] getEntryFormatReplacements(CommandHelp help, HelpEntry entry) {<a name="line.136"></a>
|
||||
<span class="sourceLineNo">137</span> //{command} {parameters} {separator} {description}<a name="line.137"></a>
|
||||
<span class="sourceLineNo">138</span> return new String[]{<a name="line.138"></a>
|
||||
<span class="sourceLineNo">139</span> "{command}", entry.getCommand(),<a name="line.139"></a>
|
||||
<span class="sourceLineNo">140</span> "{commandprefix}", help.getCommandPrefix(),<a name="line.140"></a>
|
||||
<span class="sourceLineNo">141</span> "{parameters}", entry.getParameterSyntax(),<a name="line.141"></a>
|
||||
<span class="sourceLineNo">142</span> "{separator}", entry.getDescription().isEmpty() ? "" : "-",<a name="line.142"></a>
|
||||
<span class="sourceLineNo">143</span> "{description}", entry.getDescription()<a name="line.143"></a>
|
||||
<span class="sourceLineNo">144</span> };<a name="line.144"></a>
|
||||
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
|
||||
<span class="sourceLineNo">146</span><a name="line.146"></a>
|
||||
<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
|
||||
<span class="sourceLineNo">148</span> * Override this to control replacements<a name="line.148"></a>
|
||||
<span class="sourceLineNo">149</span> *<a name="line.149"></a>
|
||||
<span class="sourceLineNo">150</span> * @param help<a name="line.150"></a>
|
||||
<span class="sourceLineNo">151</span> * @param param<a name="line.151"></a>
|
||||
<span class="sourceLineNo">152</span> * @param entry<a name="line.152"></a>
|
||||
<span class="sourceLineNo">153</span> * @return<a name="line.153"></a>
|
||||
<span class="sourceLineNo">154</span> */<a name="line.154"></a>
|
||||
<span class="sourceLineNo">155</span> @NotNull<a name="line.155"></a>
|
||||
<span class="sourceLineNo">156</span> public String[] getParameterFormatReplacements(CommandHelp help, CommandParameter param, HelpEntry entry) {<a name="line.156"></a>
|
||||
<span class="sourceLineNo">157</span> //{name} {description}<a name="line.157"></a>
|
||||
<span class="sourceLineNo">158</span> return new String[]{<a name="line.158"></a>
|
||||
<span class="sourceLineNo">159</span> "{name}", param.getName(),<a name="line.159"></a>
|
||||
<span class="sourceLineNo">160</span> "{syntax}", ACFUtil.nullDefault(param.getSyntax(), ""),<a name="line.160"></a>
|
||||
<span class="sourceLineNo">161</span> "{description}", ACFUtil.nullDefault(param.getDescription(), ""),<a name="line.161"></a>
|
||||
<span class="sourceLineNo">162</span> "{command}", help.getCommandName(),<a name="line.162"></a>
|
||||
<span class="sourceLineNo">163</span> "{fullcommand}", entry.getCommand(),<a name="line.163"></a>
|
||||
<span class="sourceLineNo">164</span> "{commandprefix}", help.getCommandPrefix()<a name="line.164"></a>
|
||||
<span class="sourceLineNo">165</span> };<a name="line.165"></a>
|
||||
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
|
||||
<span class="sourceLineNo">167</span>}<a name="line.167"></a>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user