- Specified by:
getMessageKey in interface co.aikar.locales.MessageKeyProvider
void |
+CommandHelpFormatter.printDetailedHelpCommand(CommandHelp help,
+ CommandIssuer issuer,
+ HelpEntry entry) |
+
+
+void |
CommandHelpFormatter.printDetailedHelpFooter(CommandHelp help,
CommandIssuer issuer,
HelpEntry entry) |
-
+
void |
-CommandHelpFormatter.printDetailedHelpHeader(CommandHelp help,
+CommandHelpFormatter.printDetailedHelpHeader(CommandHelp help,
CommandIssuer issuer,
- String command,
HelpEntry entry) |
|
-
+
void |
CommandHelpFormatter.printDetailedParameter(CommandHelp help,
CommandIssuer issuer,
HelpEntry entry,
CommandParameter param) |
-
-void |
-CommandHelpFormatter.printHelpEntry(CommandHelp help,
- CommandIssuer issuer,
- HelpEntry entry) |
-
void |
+CommandHelpFormatter.printHelpCommand(CommandHelp help,
+ CommandIssuer issuer,
+ HelpEntry entry) |
+
+
+void |
CommandHelpFormatter.printHelpFooter(CommandHelp help,
CommandIssuer issuer) |
-
+
void |
CommandHelpFormatter.printHelpHeader(CommandHelp help,
CommandIssuer issuer) |
-
+
void |
CommandHelpFormatter.printSearchEntry(CommandHelp help,
CommandIssuer issuer,
HelpEntry page) |
-
+
void |
CommandHelpFormatter.printSearchFooter(CommandHelp help,
CommandIssuer issuer) |
-
+
void |
CommandHelpFormatter.printSearchHeader(CommandHelp help,
CommandIssuer issuer) |
diff --git a/docs/acf-core/co/aikar/commands/class-use/CommandIssuer.html b/docs/acf-core/co/aikar/commands/class-use/CommandIssuer.html
index e9535e44..b4c3049b 100644
--- a/docs/acf-core/co/aikar/commands/class-use/CommandIssuer.html
+++ b/docs/acf-core/co/aikar/commands/class-use/CommandIssuer.html
@@ -328,90 +328,95 @@
void |
+CommandHelpFormatter.printDetailedHelpCommand(CommandHelp help,
+ CommandIssuer issuer,
+ HelpEntry entry) |
+
+
+void |
CommandHelpFormatter.printDetailedHelpFooter(CommandHelp help,
CommandIssuer issuer,
HelpEntry entry) |
-
+
void |
-CommandHelpFormatter.printDetailedHelpHeader(CommandHelp help,
+CommandHelpFormatter.printDetailedHelpHeader(CommandHelp help,
CommandIssuer issuer,
- String command,
HelpEntry entry) |
|
-
+
void |
CommandHelpFormatter.printDetailedParameter(CommandHelp help,
CommandIssuer issuer,
HelpEntry entry,
CommandParameter param) |
-
-void |
-CommandHelpFormatter.printHelpEntry(CommandHelp help,
- CommandIssuer issuer,
- HelpEntry entry) |
-
void |
+CommandHelpFormatter.printHelpCommand(CommandHelp help,
+ CommandIssuer issuer,
+ HelpEntry entry) |
+
+
+void |
CommandHelpFormatter.printHelpFooter(CommandHelp help,
CommandIssuer issuer) |
-
+
void |
CommandHelpFormatter.printHelpHeader(CommandHelp help,
CommandIssuer issuer) |
-
+
void |
CommandHelpFormatter.printSearchEntry(CommandHelp help,
CommandIssuer issuer,
HelpEntry page) |
-
+
void |
CommandHelpFormatter.printSearchFooter(CommandHelp help,
CommandIssuer issuer) |
-
+
void |
CommandHelpFormatter.printSearchHeader(CommandHelp help,
CommandIssuer issuer) |
-
+
void |
CommandManager.sendMessage(CommandIssuer issuer,
MessageType type,
co.aikar.locales.MessageKeyProvider key,
String... replacements) |
-
+
void |
CommandHelp.showDetailedHelp(HelpEntry entry,
CommandIssuer issuer) |
-
+
void |
CommandHelp.showHelp(CommandIssuer issuer) |
-
+
void |
BaseCommand.showSyntax(CommandIssuer issuer,
RegisteredCommand<?> cmd) |
-
+
List<String> |
BaseCommand.tabComplete(CommandIssuer issuer,
String commandLabel,
String[] args) |
-
+
List<String> |
ForwardingCommand.tabComplete(CommandIssuer issuer,
String alias,
String[] args) |
-
+
List<String> |
BaseCommand.tabComplete(CommandIssuer issuer,
String commandLabel,
diff --git a/docs/acf-core/co/aikar/commands/class-use/HelpEntry.html b/docs/acf-core/co/aikar/commands/class-use/HelpEntry.html
index 20591933..e7236bd7 100644
--- a/docs/acf-core/co/aikar/commands/class-use/HelpEntry.html
+++ b/docs/acf-core/co/aikar/commands/class-use/HelpEntry.html
@@ -144,42 +144,47 @@
|
void |
+CommandHelpFormatter.printDetailedHelpCommand(CommandHelp help,
+ CommandIssuer issuer,
+ HelpEntry entry) |
+
+
+void |
CommandHelpFormatter.printDetailedHelpFooter(CommandHelp help,
CommandIssuer issuer,
HelpEntry entry) |
-
+
void |
-CommandHelpFormatter.printDetailedHelpHeader(CommandHelp help,
+CommandHelpFormatter.printDetailedHelpHeader(CommandHelp help,
CommandIssuer issuer,
- String command,
HelpEntry entry) |
|
-
+
void |
CommandHelpFormatter.printDetailedParameter(CommandHelp help,
CommandIssuer issuer,
HelpEntry entry,
CommandParameter param) |
-
-void |
-CommandHelpFormatter.printHelpEntry(CommandHelp help,
- CommandIssuer issuer,
- HelpEntry entry) |
-
void |
+CommandHelpFormatter.printHelpCommand(CommandHelp help,
+ CommandIssuer issuer,
+ HelpEntry entry) |
+
+
+void |
CommandHelpFormatter.printSearchEntry(CommandHelp help,
CommandIssuer issuer,
HelpEntry page) |
-
+
void |
CommandHelp.showDetailedHelp(HelpEntry entry,
CommandIssuer issuer) |
-
+
protected void |
CommandHelp.updateSearchScore(HelpEntry help) |
diff --git a/docs/acf-core/index-all.html b/docs/acf-core/index-all.html
index 848e15e6..ec09799d 100644
--- a/docs/acf-core/index-all.html
+++ b/docs/acf-core/index-all.html
@@ -1355,13 +1355,15 @@
-
- preCommand() - Method in class co.aikar.commands.RegisteredCommand
-
+- printDetailedHelpCommand(CommandHelp, CommandIssuer, HelpEntry) - Method in class co.aikar.commands.CommandHelpFormatter
+-
- printDetailedHelpFooter(CommandHelp, CommandIssuer, HelpEntry) - Method in class co.aikar.commands.CommandHelpFormatter
-
-- printDetailedHelpHeader(CommandHelp, CommandIssuer, String, HelpEntry) - Method in class co.aikar.commands.CommandHelpFormatter
+- printDetailedHelpHeader(CommandHelp, CommandIssuer, HelpEntry) - Method in class co.aikar.commands.CommandHelpFormatter
-
- printDetailedParameter(CommandHelp, CommandIssuer, HelpEntry, CommandParameter) - Method in class co.aikar.commands.CommandHelpFormatter
-
-- printHelpEntry(CommandHelp, CommandIssuer, HelpEntry) - Method in class co.aikar.commands.CommandHelpFormatter
+- printHelpCommand(CommandHelp, CommandIssuer, HelpEntry) - Method in class co.aikar.commands.CommandHelpFormatter
-
- printHelpFooter(CommandHelp, CommandIssuer) - Method in class co.aikar.commands.CommandHelpFormatter
-
diff --git a/docs/acf-core/src-html/co/aikar/commands/CommandHelp.html b/docs/acf-core/src-html/co/aikar/commands/CommandHelp.html
index c2d5ceba..16b06203 100644
--- a/docs/acf-core/src-html/co/aikar/commands/CommandHelp.html
+++ b/docs/acf-core/src-html/co/aikar/commands/CommandHelp.html
@@ -179,7 +179,7 @@
171
172 for (HelpEntry e : printEntries) {
173 if (search == null) {
-174 formatter.printHelpEntry(this, issuer, e);
+174 formatter.printHelpCommand(this, issuer, e);
175 } else {
176 formatter.printSearchEntry(this, issuer, e);
177 }
@@ -196,10 +196,10 @@
188 public void showDetailedHelp(HelpEntry entry, CommandIssuer issuer) {
189 // header
190 CommandHelpFormatter formatter = manager.getHelpFormatter();
-191 formatter.printDetailedHelpHeader(this, issuer, commandName, entry);
+191 formatter.printDetailedHelpHeader(this, issuer, entry);
192
193 // normal help line
-194 formatter.printHelpEntry(this, issuer, entry);
+194 formatter.printDetailedHelpCommand(this, issuer, entry);
195
196 // additionally detailed help for params
197 for (CommandParameter param : entry.getParameters()) {
diff --git a/docs/acf-core/src-html/co/aikar/commands/CommandHelpFormatter.html b/docs/acf-core/src-html/co/aikar/commands/CommandHelpFormatter.html
index 91bff03f..8fc1563b 100644
--- a/docs/acf-core/src-html/co/aikar/commands/CommandHelpFormatter.html
+++ b/docs/acf-core/src-html/co/aikar/commands/CommandHelpFormatter.html
@@ -49,7 +49,7 @@
041 issuer.sendMessage(MessageType.HELP, MessageKeys.HELP_HEADER, getHeaderFooterFormatReplacements(help));
042 }
043
-044 public void printHelpEntry(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {
+044 public void printHelpCommand(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {
045 String formatted = this.manager.formatMessage(issuer, MessageType.HELP, MessageKeys.HELP_FORMAT, getEntryFormatReplacements(help, entry));
046 for (String msg : ACFPatterns.NEWLINE.split(formatted)) {
047 issuer.sendMessageInternal(ACFUtil.rtrim(msg));
@@ -82,88 +82,94 @@
074 if (help.isLastPage()) {
075 return;
076 }
-077 issuer.sendMessage(MessageType.HELP, MessageKeys.HELP_PAGE_INFORMATION, getHeaderFooterFormatReplacements(help)
-078 );
-079 }
+077 issuer.sendMessage(MessageType.HELP, MessageKeys.HELP_PAGE_INFORMATION, getHeaderFooterFormatReplacements(help));
+078 }
+079
080
-081
-082 // ############
-083 // # detailed #
-084 // ############
-085
-086 public void printDetailedHelpHeader(CommandHelp help, CommandIssuer issuer, String command, HelpEntry entry) {
-087 issuer.sendMessage(MessageType.HELP, MessageKeys.HELP_DETAILED_HEADER,
-088 "{command}", entry.getCommand(),
-089 "{command}", command
-090 );
-091 }
-092
-093 public void printDetailedParameter(CommandHelp help, CommandIssuer issuer, HelpEntry entry, CommandParameter param) {
-094 String formattedMsg = this.manager.formatMessage(issuer, MessageType.HELP, MessageKeys.HELP_DETAILED_PARAMETER_FORMAT, getParameterFormatReplacements(help, param, entry));
-095 for (String msg : ACFPatterns.NEWLINE.split(formattedMsg)) {
-096 issuer.sendMessageInternal(ACFUtil.rtrim(msg));
-097 }
-098 }
-099
-100 public void printDetailedHelpFooter(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {
-101 // default doesn't have a footer
-102 }
-103
-104 /**
-105 * Override this to control replacements
-106 *
-107 * @param help
-108 * @return
-109 */
-110 public String[] getHeaderFooterFormatReplacements(CommandHelp help) {
-111 return new String[]{
-112 "{search}", help.search != null ? String.join(" ", help.search) : "",
-113 "{command}", help.getCommandName(),
-114 "{rootcommand}", help.getCommandName(),
-115 "{page}", "" + help.getPage(),
-116 "{totalpages}", "" + help.getTotalPages(),
-117 "{results}", "" + help.getTotalResults()
-118 };
-119 }
-120
-121 /**
-122 * Override this to control replacements
-123 *
-124 * @param help
-125 * @param e
-126 * @return
-127 */
-128 public String[] getEntryFormatReplacements(CommandHelp help, HelpEntry e) {
-129 //{command} {parameters} {separator} {description}
-130 return new String[]{
-131 "{command}", e.getCommand(),
-132 "{rootcommand}", help.getCommandName(),
-133 "{parameters}", e.getParameterSyntax(),
-134 "{separator}", e.getDescription().isEmpty() ? "" : "-",
-135 "{description}", e.getDescription()
-136 };
-137 }
-138
-139 /**
-140 * Override this to control replacements
-141 *
-142 * @param help
-143 * @param param
-144 * @param page
-145 * @return
-146 */
-147 @NotNull
-148 public String[] getParameterFormatReplacements(CommandHelp help, CommandParameter param, HelpEntry page) {
-149 //{name} {description}
-150 return new String[]{
-151 "{name}", param.getName(),
-152 "{syntax}", ACFUtil.nullDefault(param.getSyntax(), ""),
-153 "{description}", ACFUtil.nullDefault(param.getDescription(), ""),
-154 "{command}", page.getCommand(),
-155 "{rootcommand}", help.getCommandName()
-156 };
-157 }
-158}
+081 // ############
+082 // # detailed #
+083 // ############
+084
+085 public void printDetailedHelpHeader(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {
+086 issuer.sendMessage(MessageType.HELP, MessageKeys.HELP_DETAILED_HEADER,
+087 "{command}", entry.getCommand()
+088 );
+089 }
+090
+091
+092 public void printDetailedHelpCommand(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {
+093 String formatted = this.manager.formatMessage(issuer, MessageType.HELP, MessageKeys.HELP_DETAILED_COMMAND_FORMAT, getEntryFormatReplacements(help, entry));
+094 for (String msg : ACFPatterns.NEWLINE.split(formatted)) {
+095 issuer.sendMessageInternal(ACFUtil.rtrim(msg));
+096 }
+097 }
+098
+099 public void printDetailedParameter(CommandHelp help, CommandIssuer issuer, HelpEntry entry, CommandParameter param) {
+100 String formattedMsg = this.manager.formatMessage(issuer, MessageType.HELP, MessageKeys.HELP_DETAILED_PARAMETER_FORMAT, getParameterFormatReplacements(help, param, entry));
+101 for (String msg : ACFPatterns.NEWLINE.split(formattedMsg)) {
+102 issuer.sendMessageInternal(ACFUtil.rtrim(msg));
+103 }
+104 }
+105
+106 public void printDetailedHelpFooter(CommandHelp help, CommandIssuer issuer, HelpEntry entry) {
+107 // default doesn't have a footer
+108 }
+109
+110 /**
+111 * Override this to control replacements
+112 *
+113 * @param help
+114 * @return
+115 */
+116 public String[] getHeaderFooterFormatReplacements(CommandHelp help) {
+117 return new String[]{
+118 "{search}", help.search != null ? String.join(" ", help.search) : "",
+119 "{command}", help.getCommandName(),
+120 "{rootcommand}", help.getCommandName(),
+121 "{page}", "" + help.getPage(),
+122 "{totalpages}", "" + help.getTotalPages(),
+123 "{results}", "" + help.getTotalResults()
+124 };
+125 }
+126
+127 /**
+128 * Override this to control replacements
+129 *
+130 * @param help
+131 * @param e
+132 * @return
+133 */
+134 public String[] getEntryFormatReplacements(CommandHelp help, HelpEntry e) {
+135 //{command} {parameters} {separator} {description}
+136 return new String[]{
+137 "{command}", e.getCommand(),
+138 "{rootcommand}", help.getCommandName(),
+139 "{parameters}", e.getParameterSyntax(),
+140 "{separator}", e.getDescription().isEmpty() ? "" : "-",
+141 "{description}", e.getDescription()
+142 };
+143 }
+144
+145 /**
+146 * Override this to control replacements
+147 *
+148 * @param help
+149 * @param param
+150 * @param page
+151 * @return
+152 */
+153 @NotNull
+154 public String[] getParameterFormatReplacements(CommandHelp help, CommandParameter param, HelpEntry page) {
+155 //{name} {description}
+156 return new String[]{
+157 "{name}", param.getName(),
+158 "{syntax}", ACFUtil.nullDefault(param.getSyntax(), ""),
+159 "{description}", ACFUtil.nullDefault(param.getDescription(), ""),
+160 "{command}", page.getCommand(),
+161 "{rootcommand}", help.getCommandName()
+162 };
+163 }
+164}
diff --git a/docs/acf-core/src-html/co/aikar/commands/MessageKeys.html b/docs/acf-core/src-html/co/aikar/commands/MessageKeys.html
index b4c5ff40..5dc53266 100644
--- a/docs/acf-core/src-html/co/aikar/commands/MessageKeys.html
+++ b/docs/acf-core/src-html/co/aikar/commands/MessageKeys.html
@@ -60,15 +60,16 @@
052 HELP_HEADER,
053 HELP_FORMAT,
054 HELP_DETAILED_HEADER,
-055 HELP_DETAILED_PARAMETER_FORMAT,
-056 HELP_SEARCH_HEADER,
-057 ;
-058
-059 private final MessageKey key = MessageKey.of("acf-core." + this.name().toLowerCase());
-060 public MessageKey getMessageKey() {
-061 return key;
-062 }
-063}
+055 HELP_DETAILED_COMMAND_FORMAT,
+056 HELP_DETAILED_PARAMETER_FORMAT,
+057 HELP_SEARCH_HEADER,
+058 ;
+059
+060 private final MessageKey key = MessageKey.of("acf-core." + this.name().toLowerCase());
+061 public MessageKey getMessageKey() {
+062 return key;
+063 }
+064}