Package co.aikar.commands
Class CommandHelpFormatter
java.lang.Object
co.aikar.commands.CommandHelpFormatter
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionString[]
getEntryFormatReplacements
(CommandHelp help, HelpEntry entry) Override this to control replacementsString[]
Override this to control replacements@NotNull String[]
getParameterFormatReplacements
(CommandHelp help, CommandParameter param, HelpEntry entry) Override this to control replacementsvoid
printDetailedHelpCommand
(CommandHelp help, CommandIssuer issuer, HelpEntry entry) void
printDetailedHelpFooter
(CommandHelp help, CommandIssuer issuer, HelpEntry entry) void
printDetailedHelpHeader
(CommandHelp help, CommandIssuer issuer, HelpEntry entry) void
printDetailedParameter
(CommandHelp help, CommandIssuer issuer, HelpEntry entry, CommandParameter param) void
printHelpCommand
(CommandHelp help, CommandIssuer issuer, HelpEntry entry) void
printHelpFooter
(CommandHelp help, CommandIssuer issuer) void
printHelpHeader
(CommandHelp help, CommandIssuer issuer) void
printSearchEntry
(CommandHelp help, CommandIssuer issuer, HelpEntry page) void
printSearchFooter
(CommandHelp help, CommandIssuer issuer) void
printSearchHeader
(CommandHelp help, CommandIssuer issuer) void
showAllResults
(CommandHelp commandHelp, List<HelpEntry> entries) void
showDetailedHelp
(CommandHelp commandHelp, HelpEntry entry) void
showSearchResults
(CommandHelp commandHelp, List<HelpEntry> entries)
-
Constructor Details
-
CommandHelpFormatter
-
-
Method Details
-
showAllResults
-
showSearchResults
-
showDetailedHelp
-
printHelpHeader
-
printHelpCommand
-
printSearchHeader
-
printSearchEntry
-
printDetailedHelpHeader
-
printDetailedHelpCommand
-
printDetailedParameter
public void printDetailedParameter(CommandHelp help, CommandIssuer issuer, HelpEntry entry, CommandParameter param) -
getEntryFormatReplacements
Override this to control replacements- Parameters:
help
-entry
-- Returns:
-
getParameterFormatReplacements
@NotNull public @NotNull String[] getParameterFormatReplacements(CommandHelp help, CommandParameter param, HelpEntry entry) Override this to control replacements- Parameters:
help
-param
-entry
-- Returns:
-