From a06affc9325a23fe28f82a735f12567a4f906f5f Mon Sep 17 00:00:00 2001 From: Aikar Date: Wed, 21 Mar 2018 23:02:31 -0400 Subject: [PATCH] (DEPLOYED ACF) Updated JavaDocs --- .../aikar/commands/BukkitCommandManager.html | 49 +- docs/acf-bukkit/index-all.html | 2 + .../aikar/commands/BukkitCommandManager.html | 7 +- .../aikar/commands/BungeeCommandManager.html | 43 +- docs/acf-bungee/index-all.html | 2 + .../aikar/commands/BungeeCommandManager.html | 8 +- docs/acf-core/allclasses-frame.html | 1 + docs/acf-core/allclasses-noframe.html | 1 + .../co/aikar/commands/BaseCommand.html | 56 +- .../co/aikar/commands/CommandContexts.html | 12 +- .../co/aikar/commands/CommandHelp.html | 225 ++- .../aikar/commands/CommandHelpFormatter.html | 482 +++++++ .../co/aikar/commands/CommandIssuer.html | 4 +- .../co/aikar/commands/CommandManager.html | 262 ++-- .../acf-core/co/aikar/commands/HelpEntry.html | 41 +- docs/acf-core/co/aikar/commands/Locales.html | 104 +- .../co/aikar/commands/MessageKeys.html | 78 +- .../aikar/commands/class-use/CommandHelp.html | 83 ++ .../class-use/CommandHelpFormatter.html | 197 +++ .../commands/class-use/CommandIssuer.html | 78 +- .../commands/class-use/CommandManager.html | 3 + .../commands/class-use/CommandParameter.html | 20 + .../aikar/commands/class-use/HelpEntry.html | 64 +- .../aikar/commands/class-use/UnstableAPI.html | 16 + .../co/aikar/commands/package-frame.html | 1 + .../co/aikar/commands/package-summary.html | 24 +- .../co/aikar/commands/package-tree.html | 1 + .../co/aikar/commands/package-use.html | 33 +- docs/acf-core/deprecated-list.html | 20 +- docs/acf-core/index-all.html | 86 +- docs/acf-core/overview-tree.html | 1 + .../co/aikar/commands/BaseCommand.html | 1220 ++++++++--------- .../co/aikar/commands/CommandContexts.html | 182 +-- .../co/aikar/commands/CommandHelp.html | 398 +++--- .../aikar/commands/CommandHelpFormatter.html | 230 ++++ .../co/aikar/commands/CommandManager.html | 844 ++++++------ .../src-html/co/aikar/commands/HelpEntry.html | 75 +- .../src-html/co/aikar/commands/Locales.html | 334 ++--- .../co/aikar/commands/MessageKeys.html | 26 +- .../co/aikar/commands/JDACommandManager.html | 53 +- docs/acf-jda/index-all.html | 2 + .../co/aikar/commands/JDACommandManager.html | 86 +- .../aikar/commands/PaperCommandManager.html | 6 +- .../aikar/commands/SpongeCommandManager.html | 35 +- docs/acf-sponge/index-all.html | 2 + .../aikar/commands/SpongeCommandManager.html | 7 +- 46 files changed, 3605 insertions(+), 1899 deletions(-) create mode 100644 docs/acf-core/co/aikar/commands/CommandHelpFormatter.html create mode 100644 docs/acf-core/co/aikar/commands/class-use/CommandHelpFormatter.html create mode 100644 docs/acf-core/src-html/co/aikar/commands/CommandHelpFormatter.html diff --git a/docs/acf-bukkit/co/aikar/commands/BukkitCommandManager.html b/docs/acf-bukkit/co/aikar/commands/BukkitCommandManager.html index b26aa5a1..f4692f75 100644 --- a/docs/acf-bukkit/co/aikar/commands/BukkitCommandManager.html +++ b/docs/acf-bukkit/co/aikar/commands/BukkitCommandManager.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":42,"i19":10,"i20":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":42,"i20":10,"i21":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -167,7 +167,7 @@ extends co.aikar.commands.CommandManager<org.bukkit.command.CommandSender,

Fields inherited from class co.aikar.commands.CommandManager

-conditions, defaultExceptionHandler, defaultFormatter, defaultHelpPerPage, dependencies, formatters, issuersLocale, localeChangedCallbacks, replacements, rootCommands, supportedLanguages, usePerIssuerLocale +conditions, defaultExceptionHandler, defaultFormatter, defaultHelpPerPage, dependencies, formatters, helpFormatter, issuersLocale, localeChangedCallbacks, replacements, rootCommands, supportedLanguages, usePerIssuerLocale @@ -246,50 +246,54 @@ extends co.aikar.commands.CommandManager<org.bukkit.command.CommandSender,getCommandIssuer(Object issuer)  +String +getCommandPrefix(co.aikar.commands.CommandIssuer issuer)  + + BukkitLocales getLocales()  - + org.bukkit.plugin.Plugin getPlugin()  - + co.aikar.timings.lib.TimingManager getTimings()  - + boolean hasRegisteredCommands()  - + boolean isCommandIssuer(Class<?> type)  - + void log(co.aikar.commands.LogLevel level, String message, Throwable throwable)  - + void registerCommand(co.aikar.commands.BaseCommand command)  - + void registerCommand(co.aikar.commands.BaseCommand command, boolean force)  - + Locale setPlayerLocale(org.bukkit.entity.Player player, Locale locale)  - + void unregisterCommand(co.aikar.commands.BaseCommand command)  - + void unregisterCommand(BukkitRootCommand command)
Deprecated.  @@ -297,11 +301,11 @@ extends co.aikar.commands.CommandManager<org.bukkit.command.CommandSender, - + void unregisterCommands()  - + boolean usePerIssuerLocale(boolean usePerIssuerLocale, boolean autoDetectFromClient)  @@ -312,7 +316,7 @@ extends co.aikar.commands.CommandManager<org.bukkit.command.CommandSender,

Methods inherited from class co.aikar.commands.CommandManager

-addSupportedLanguage, enableUnstableAPI, formatMessage, generateCommandHelp, generateCommandHelp, generateCommandHelp, generateCommandHelp, getCommandConditions, getCommandReplacements, getCurrentCommandIssuer, getCurrentCommandManager, getCurrentCommandOperationContext, getDefaultExceptionHandler, getDefaultFormatter, getDefaultHelpPerPage, getFormat, getIssuerLocale, getRootCommand, getSupportedLanguages, handleUncaughtException, hasPermission, log, notifyLocaleChange, obtainRootCommand, onLocaleChange, registerDependency, registerDependency, sendMessage, sendMessage, setDefaultExceptionHandler, setDefaultFormatter, setDefaultHelpPerPage, setFormat, setFormat, setFormat, setIssuerLocale, usePerIssuerLocale, usingPerIssuerLocale +addSupportedLanguage, enableUnstableAPI, formatMessage, generateCommandHelp, generateCommandHelp, generateCommandHelp, generateCommandHelp, getCommandConditions, getCommandReplacements, getCurrentCommandIssuer, getCurrentCommandManager, getCurrentCommandOperationContext, getDefaultExceptionHandler, getDefaultFormatter, getDefaultHelpPerPage, getFormat, getHelpFormatter, getIssuerLocale, getRootCommand, getSupportedLanguages, handleUncaughtException, hasPermission, log, notifyLocaleChange, obtainRootCommand, onLocaleChange, registerDependency, registerDependency, sendMessage, sendMessage, setDefaultExceptionHandler, setDefaultFormatter, setDefaultHelpPerPage, setFormat, setFormat, setFormat, setHelpFormatter, setIssuerLocale, usePerIssuerLocale, usingPerIssuerLocale @@ -238,44 +238,48 @@ extends co.aikar.commands.CommandManager<net.md_5.bungee.api.CommandSender,getCommandIssuer(Object issuer)  +String +getCommandPrefix(co.aikar.commands.CommandIssuer issuer)  + + BungeeLocales getLocales()  - + net.md_5.bungee.api.plugin.Plugin getPlugin()  - + boolean hasRegisteredCommands()  - + boolean isCommandIssuer(Class<?> aClass)  - + void log(co.aikar.commands.LogLevel level, String message, Throwable throwable)  - + void readLocale(net.md_5.bungee.api.connection.ProxiedPlayer player)  - + void registerCommand(co.aikar.commands.BaseCommand command)  - + void unregisterCommand(co.aikar.commands.BaseCommand command)  - + void unregisterCommand(BungeeRootCommand command)  - + void unregisterCommands()  @@ -285,7 +289,7 @@ extends co.aikar.commands.CommandManager<net.md_5.bungee.api.CommandSender,

Methods inherited from class co.aikar.commands.CommandManager

-addSupportedLanguage, enableUnstableAPI, formatMessage, generateCommandHelp, generateCommandHelp, generateCommandHelp, generateCommandHelp, getCommandConditions, getCommandReplacements, getCurrentCommandIssuer, getCurrentCommandManager, getCurrentCommandOperationContext, getDefaultExceptionHandler, getDefaultFormatter, getDefaultHelpPerPage, getFormat, getIssuerLocale, getRootCommand, getSupportedLanguages, handleUncaughtException, hasPermission, log, notifyLocaleChange, obtainRootCommand, onLocaleChange, registerDependency, registerDependency, sendMessage, sendMessage, setDefaultExceptionHandler, setDefaultFormatter, setDefaultHelpPerPage, setFormat, setFormat, setFormat, setIssuerLocale, usePerIssuerLocale, usingPerIssuerLocale +addSupportedLanguage, enableUnstableAPI, formatMessage, generateCommandHelp, generateCommandHelp, generateCommandHelp, generateCommandHelp, getCommandConditions, getCommandReplacements, getCurrentCommandIssuer, getCurrentCommandManager, getCurrentCommandOperationContext, getDefaultExceptionHandler, getDefaultFormatter, getDefaultHelpPerPage, getFormat, getHelpFormatter, getIssuerLocale, getRootCommand, getSupportedLanguages, handleUncaughtException, hasPermission, log, notifyLocaleChange, obtainRootCommand, onLocaleChange, registerDependency, registerDependency, sendMessage, sendMessage, setDefaultExceptionHandler, setDefaultFormatter, setDefaultHelpPerPage, setFormat, setFormat, setFormat, setHelpFormatter, setIssuerLocale, usePerIssuerLocale, usingPerIssuerLocale @@ -378,7 +378,7 @@ extends
  • BaseCommand

    -
    public BaseCommand(String cmd)
    +
    public BaseCommand(String cmd)
  • @@ -395,7 +395,7 @@ extends
  • getExecCommandLabel

    -
    public String getExecCommandLabel()
    +
    public String getExecCommandLabel()
    Gets the root command name that the user actually typed
    Returns:
    @@ -409,7 +409,7 @@ extends
  • getExecSubcommand

    -
    public String getExecSubcommand()
    +
    public String getExecSubcommand()
    Gets the actual sub command name the user typed
    Returns:
    @@ -423,7 +423,7 @@ extends
  • getOrigArgs

    -
    public String[] getOrigArgs()
    +
    public String[] getOrigArgs()
    Gets the actual args in string form the user typed
    Returns:
    @@ -437,7 +437,7 @@ extends
  • execute

    -
    public void execute(CommandIssuer issuer,
    +
    public void execute(CommandIssuer issuer,
                         String commandLabel,
                         String[] args)
  • @@ -448,7 +448,7 @@ extends
  • getCurrentCommandIssuer

    -
    public CommandIssuer getCurrentCommandIssuer()
    +
    public CommandIssuer getCurrentCommandIssuer()
  • @@ -457,7 +457,7 @@ extends
  • getCurrentCommandManager

    -
    public CommandManager getCurrentCommandManager()
    +
    public CommandManager getCurrentCommandManager()
  • @@ -466,7 +466,7 @@ extends
  • canExecute

    -
    public boolean canExecute(CommandIssuer issuer,
    +
    public boolean canExecute(CommandIssuer issuer,
                               RegisteredCommand<?> cmd)
  • @@ -476,7 +476,7 @@ extends
  • tabComplete

    -
    public List<StringtabComplete(CommandIssuer issuer,
    +
    public List<StringtabComplete(CommandIssuer issuer,
                                     String commandLabel,
                                     String[] args)
  • @@ -487,7 +487,7 @@ extends
  • tabComplete

    -
    public List<StringtabComplete(CommandIssuer issuer,
    +
    public List<StringtabComplete(CommandIssuer issuer,
                                     String commandLabel,
                                     String[] args,
                                     boolean isAsync)
    @@ -505,7 +505,7 @@ extends 
     

    getCommandHelp

    @Deprecated
    -public CommandHelp getCommandHelp()
    +public CommandHelp getCommandHelp()
    Deprecated. Unstable API
  • @@ -516,7 +516,7 @@ public 

    showCommandHelp

    @Deprecated
    -public void showCommandHelp()
    +public void showCommandHelp()
    Deprecated. Unstable API
  • @@ -526,7 +526,7 @@ public void 
  • help

    -
    public void help(Object issuer,
    +
    public void help(Object issuer,
                      String[] args)
  • @@ -536,7 +536,7 @@ public void 
  • help

    -
    public void help(CommandIssuer issuer,
    +
    public void help(CommandIssuer issuer,
                      String[] args)
  • @@ -546,7 +546,7 @@ public void 
  • doHelp

    -
    public void doHelp(Object issuer,
    +
    public void doHelp(Object issuer,
                        String... args)
  • @@ -556,7 +556,7 @@ public void 
  • doHelp

    -
    public void doHelp(CommandIssuer issuer,
    +
    public void doHelp(CommandIssuer issuer,
                        String... args)
  • @@ -566,7 +566,7 @@ public void 
  • showSyntax

    -
    public void showSyntax(CommandIssuer issuer,
    +
    public void showSyntax(CommandIssuer issuer,
                            RegisteredCommand<?> cmd)
  • @@ -576,7 +576,7 @@ public void 
  • hasPermission

    -
    public boolean hasPermission(Object issuer)
    +
    public boolean hasPermission(Object issuer)
  • @@ -585,7 +585,7 @@ public void 
  • hasPermission

    -
    public boolean hasPermission(CommandIssuer issuer)
    +
    public boolean hasPermission(CommandIssuer issuer)
  • @@ -594,7 +594,7 @@ public void 
  • getRequiredPermissions

    -
    public Set<StringgetRequiredPermissions()
    +
    public Set<StringgetRequiredPermissions()
  • @@ -603,7 +603,7 @@ public void 
  • requiresPermission

    -
    public boolean requiresPermission(String permission)
    +
    public boolean requiresPermission(String permission)
  • @@ -612,7 +612,7 @@ public void 
  • getName

    -
    public String getName()
    +
    public String getName()
  • @@ -621,7 +621,7 @@ public void 
  • getExceptionHandler

    -
    public ExceptionHandler getExceptionHandler()
    +
    public ExceptionHandler getExceptionHandler()
  • @@ -630,7 +630,7 @@ public void 
  • setExceptionHandler

    -
    public BaseCommand setExceptionHandler(ExceptionHandler exceptionHandler)
    +
    public BaseCommand setExceptionHandler(ExceptionHandler exceptionHandler)
  • @@ -639,7 +639,7 @@ public void 
  • getDefaultRegisteredCommand

    -
    public RegisteredCommand getDefaultRegisteredCommand()
    +
    public RegisteredCommand getDefaultRegisteredCommand()
  • @@ -648,7 +648,7 @@ public void 
  • setContextFlags

    -
    public String setContextFlags(Class<?> cls,
    +
    public String setContextFlags(Class<?> cls,
                                   String flags)
  • @@ -658,7 +658,7 @@ public void 
  • getContextFlags

    -
    public String getContextFlags(Class<?> cls)
    +
    public String getContextFlags(Class<?> cls)
  • diff --git a/docs/acf-core/co/aikar/commands/CommandContexts.html b/docs/acf-core/co/aikar/commands/CommandContexts.html index e6066735..042c8e1c 100644 --- a/docs/acf-core/co/aikar/commands/CommandContexts.html +++ b/docs/acf-core/co/aikar/commands/CommandContexts.html @@ -249,7 +249,7 @@ extends

    registerSenderAwareContext

    @Deprecated
    -public <T> void registerSenderAwareContext(Class<T> context,
    +public <T> void registerSenderAwareContext(Class<T> context,
                                                            IssuerAwareContextResolver<T,R> supplier)
    Deprecated. Please switch to registerIssuerAwareContext(Class, IssuerAwareContextResolver) as the core wants to use the platform agnostic term of "Issuer" instead of Sender
    @@ -265,7 +265,7 @@ public <T> void 
  • registerIssuerAwareContext

    -
    public <T> void registerIssuerAwareContext(Class<T> context,
    +
    public <T> void registerIssuerAwareContext(Class<T> context,
                                                IssuerAwareContextResolver<T,R> supplier)
    Registers a context resolver that may conditionally consume input, falling back to using the context of the issuer to potentially fulfill this context. @@ -279,7 +279,7 @@ public <T> void 
  • registerIssuerOnlyContext

    -
    public <T> void registerIssuerOnlyContext(Class<T> context,
    +
    public <T> void registerIssuerOnlyContext(Class<T> context,
                                               IssuerOnlyContextResolver<T,R> supplier)
    Registers a context resolver that will never consume input. It will always satisfy its context based on the issuer of the command, so it will not appear in syntax strings.
    @@ -291,7 +291,7 @@ public <T> void 
  • registerOptionalContext

    -
    public <T> void registerOptionalContext(Class<T> context,
    +
    public <T> void registerOptionalContext(Class<T> context,
                                             OptionalContextResolver<T,R> supplier)
    Registers a context that can safely accept a null input from the command issuer to resolve. This resolver should always call CommandExecutionContext.popFirstArg()
    @@ -303,7 +303,7 @@ public <T> void 
  • registerContext

    -
    public <T> void registerContext(Class<T> context,
    +
    public <T> void registerContext(Class<T> context,
                                     ContextResolver<T,R> supplier)
    Registers a context that requires input from the command issuer to resolve. This resolver should always call CommandExecutionContext.popFirstArg()
    @@ -315,7 +315,7 @@ public <T> void 
  • getResolver

    -
    public ContextResolver<?,RgetResolver(Class<?> type)
    +
    public ContextResolver<?,RgetResolver(Class<?> type)
  • diff --git a/docs/acf-core/co/aikar/commands/CommandHelp.html b/docs/acf-core/co/aikar/commands/CommandHelp.html index e6994c97..c22223d7 100644 --- a/docs/acf-core/co/aikar/commands/CommandHelp.html +++ b/docs/acf-core/co/aikar/commands/CommandHelp.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; - + void sendMessage(CommandIssuer issuer, MessageType type, co.aikar.locales.MessageKeyProvider key, String... replacements)  - + void sendMessage(IT issuerArg, MessageType type, co.aikar.locales.MessageKeyProvider key, String... replacements)  - + void setDefaultExceptionHandler(ExceptionHandler exceptionHandler)
    Sets the default ExceptionHandler that is called when an exception occurs while executing a command, if the command doesn't have it's own exception handler registered.
    - + void setDefaultFormatter(MF defaultFormatter)  - + void setDefaultHelpPerPage(int defaultHelpPerPage)
    Deprecated.  @@ -481,32 +497,40 @@ extends + void setFormat(MessageType type, FT... colors)  - + void setFormat(MessageType type, int i, FT color)  - + MF setFormat(MessageType type, MF formatter)  - + +void +setHelpFormatter(CommandHelpFormatter helpFormatter) +
    Deprecated.  +
    Unstable API
    +
    + + + Locale setIssuerLocale(IT issuer, Locale locale)  - + boolean usePerIssuerLocale(boolean setting)  - + boolean usingPerIssuerLocale()  @@ -577,13 +601,22 @@ extends Class<?>,String,Object> dependencies
  • + + + + @@ -592,7 +625,7 @@ extends
  • localeChangedCallbacks

    -
    protected List<IssuerLocaleChangedCallback<I extends CommandIssuer>> localeChangedCallbacks
    +
    protected List<IssuerLocaleChangedCallback<I extends CommandIssuer>> localeChangedCallbacks
  • @@ -601,7 +634,7 @@ extends
  • supportedLanguages

    -
    protected Set<Locale> supportedLanguages
    +
    protected Set<Locale> supportedLanguages
  • @@ -610,7 +643,7 @@ extends
  • formatters

    -
    protected Map<MessageType,MF extends MessageFormatter<FT>> formatters
    +
    protected Map<MessageType,MF extends MessageFormatter<FT>> formatters
  • @@ -619,7 +652,7 @@ extends
  • defaultFormatter

    -
    protected MF extends MessageFormatter<FT> defaultFormatter
    +
    protected MF extends MessageFormatter<FT> defaultFormatter
  • @@ -628,7 +661,7 @@ extends
  • defaultHelpPerPage

    -
    protected int defaultHelpPerPage
    +
    protected int defaultHelpPerPage
  • @@ -637,7 +670,7 @@ extends
  • issuersLocale

    -
    protected Map<UUID,Locale> issuersLocale
    +
    protected Map<UUID,Locale> issuersLocale
  • @@ -671,7 +704,7 @@ extends
  • getCurrentCommandOperationContext

    -
    public static CommandOperationContext getCurrentCommandOperationContext()
    +
    public static CommandOperationContext getCurrentCommandOperationContext()
  • @@ -680,7 +713,7 @@ extends
  • getCurrentCommandIssuer

    -
    public static CommandIssuer getCurrentCommandIssuer()
    +
    public static CommandIssuer getCurrentCommandIssuer()
  • @@ -689,7 +722,7 @@ extends
  • getCurrentCommandManager

    -
    public static CommandManager getCurrentCommandManager()
    +
    public static CommandManager getCurrentCommandManager()
  • @@ -700,7 +733,7 @@ extends
  • setFormat

    -
    public MF setFormat(MessageType type,
    +
    public MF setFormat(MessageType type,
                         MF formatter)
  • @@ -710,7 +743,7 @@ extends
  • getFormat

    -
    public MF getFormat(MessageType type)
    +
    public MF getFormat(MessageType type)
  • @@ -721,7 +754,7 @@ extends
  • setFormat

    -
    public void setFormat(MessageType type,
    +
    public void setFormat(MessageType type,
                           FT... colors)
  • @@ -733,7 +766,7 @@ extends
  • setFormat

    -
    public void setFormat(MessageType type,
    +
    public void setFormat(MessageType type,
                           int i,
                           FT color)
  • @@ -744,7 +777,7 @@ extends
  • getDefaultFormatter

    -
    public MF getDefaultFormatter()
    +
    public MF getDefaultFormatter()
  • @@ -755,7 +788,7 @@ extends
  • setDefaultFormatter

    -
    public void setDefaultFormatter(MF defaultFormatter)
    +
    public void setDefaultFormatter(MF defaultFormatter)
  • @@ -764,7 +797,7 @@ extends
  • getCommandConditions

    -
    public CommandConditions<I,CEC,CCgetCommandConditions()
    +
    public CommandConditions<I,CEC,CCgetCommandConditions()
  • @@ -773,7 +806,7 @@ extends
  • getCommandContexts

    -
    public abstract CommandContexts<?> getCommandContexts()
    +
    public abstract CommandContexts<?> getCommandContexts()
    Gets the command contexts manager
    Returns:
    @@ -787,7 +820,7 @@ extends
  • getCommandCompletions

    -
    public abstract CommandCompletions<?> getCommandCompletions()
    +
    public abstract CommandCompletions<?> getCommandCompletions()
    Gets the command completions manager
    Returns:
    @@ -802,7 +835,7 @@ extends

    generateCommandHelp

    @Deprecated
    -public CommandHelp generateCommandHelp(@NotNull
    +public CommandHelp generateCommandHelp(@NotNull
                                                        @NotNull String command)
    Deprecated. Unstable API
  • @@ -814,7 +847,7 @@ public 

    generateCommandHelp

    @Deprecated
    -public CommandHelp generateCommandHelp(CommandIssuer issuer,
    +public CommandHelp generateCommandHelp(CommandIssuer issuer,
                                                        @NotNull
                                                        @NotNull String command)
    Deprecated. Unstable API
    @@ -827,7 +860,7 @@ public 

    generateCommandHelp

    @Deprecated
    -public CommandHelp generateCommandHelp()
    +public CommandHelp generateCommandHelp()
  • Deprecated. Unstable API
  • @@ -838,7 +871,7 @@ public 

    generateCommandHelp

    @Deprecated
    -public CommandHelp generateCommandHelp(CommandIssuer issuer,
    +public CommandHelp generateCommandHelp(CommandIssuer issuer,
                                                        co.aikar.commands.RootCommand rootCommand)
    Deprecated. Unstable API
  • @@ -850,7 +883,7 @@ public 

    getDefaultHelpPerPage

    @Deprecated
    -public int getDefaultHelpPerPage()
    +public int getDefaultHelpPerPage()
    Deprecated. Unstable API
    @@ -861,7 +894,29 @@ public int 

    setDefaultHelpPerPage

    @Deprecated
    -public void setDefaultHelpPerPage(int defaultHelpPerPage)
    +public void setDefaultHelpPerPage(int defaultHelpPerPage) +
    Deprecated. Unstable API
    + + + + + + + + + + @@ -871,7 +926,7 @@ public void 
  • registerCommand

    -
    public abstract void registerCommand(BaseCommand command)
    +
    public abstract void registerCommand(BaseCommand command)
    Registers a command with ACF
    Parameters:
    @@ -885,7 +940,7 @@ public void 
  • hasRegisteredCommands

    -
    public abstract boolean hasRegisteredCommands()
    +
    public abstract boolean hasRegisteredCommands()
  • @@ -894,7 +949,7 @@ public void 
  • isCommandIssuer

    -
    public abstract boolean isCommandIssuer(Class<?> type)
    +
    public abstract boolean isCommandIssuer(Class<?> type)
  • @@ -903,7 +958,7 @@ public void 
  • getCommandIssuer

    -
    public abstract I getCommandIssuer(Object issuer)
    +
    public abstract I getCommandIssuer(Object issuer)
  • @@ -912,7 +967,7 @@ public void 
  • createRootCommand

    -
    public abstract co.aikar.commands.RootCommand createRootCommand(String cmd)
    +
    public abstract co.aikar.commands.RootCommand createRootCommand(String cmd)
  • @@ -921,7 +976,7 @@ public void 
  • getLocales

    -
    public abstract Locales getLocales()
    +
    public abstract Locales getLocales()
    Returns a Locales Manager to add and modify language tables for your commands.
    Returns:
    @@ -934,7 +989,7 @@ public void 
  • usingPerIssuerLocale

    -
    public boolean usingPerIssuerLocale()
    +
    public boolean usingPerIssuerLocale()
  • @@ -943,7 +998,7 @@ public void 
  • usePerIssuerLocale

    -
    public boolean usePerIssuerLocale(boolean setting)
    +
    public boolean usePerIssuerLocale(boolean setting)
  • @@ -952,7 +1007,7 @@ public void 
  • createConditionContext

    -
    public ConditionContext createConditionContext(CommandIssuer issuer,
    +
    public ConditionContext createConditionContext(CommandIssuer issuer,
                                                    String config)
  • @@ -962,7 +1017,7 @@ public void 
  • createCommandContext

    -
    public abstract CommandExecutionContext createCommandContext(RegisteredCommand command,
    +
    public abstract CommandExecutionContext createCommandContext(RegisteredCommand command,
                                                                  CommandParameter parameter,
                                                                  CommandIssuer sender,
                                                                  List<String> args,
    @@ -976,7 +1031,7 @@ public void 
     
  • createCompletionContext

    -
    public abstract CommandCompletionContext createCompletionContext(RegisteredCommand command,
    +
    public abstract CommandCompletionContext createCompletionContext(RegisteredCommand command,
                                                                      CommandIssuer sender,
                                                                      String input,
                                                                      String config,
    @@ -989,7 +1044,7 @@ public void 
     
  • log

    -
    public abstract void log(co.aikar.commands.LogLevel level,
    +
    public abstract void log(co.aikar.commands.LogLevel level,
                              String message,
                              Throwable throwable)
  • @@ -1000,7 +1055,7 @@ public void 
  • log

    -
    public void log(co.aikar.commands.LogLevel level,
    +
    public void log(co.aikar.commands.LogLevel level,
                     String message)
  • @@ -1010,7 +1065,7 @@ public void 
  • getCommandReplacements

    -
    public CommandReplacements getCommandReplacements()
    +
    public CommandReplacements getCommandReplacements()
    Lets you add custom string replacements that can be applied to annotation values, to reduce duplication/repetition of common values such as permission nodes and command prefixes. @@ -1029,7 +1084,7 @@ public void 
  • hasPermission

    -
    public boolean hasPermission(CommandIssuer issuer,
    +
    public boolean hasPermission(CommandIssuer issuer,
                                  String permission)
  • @@ -1039,7 +1094,7 @@ public void 
  • getRootCommand

    -
    public co.aikar.commands.RootCommand getRootCommand(@NotNull
    +
    public co.aikar.commands.RootCommand getRootCommand(@NotNull
                                                         @NotNull String cmd)
  • @@ -1049,7 +1104,7 @@ public void 
  • obtainRootCommand

    -
    public co.aikar.commands.RootCommand obtainRootCommand(@NotNull
    +
    public co.aikar.commands.RootCommand obtainRootCommand(@NotNull
                                                            @NotNull String cmd)
  • @@ -1059,7 +1114,7 @@ public void 
  • createRegisteredCommand

    -
    public RegisteredCommand createRegisteredCommand(BaseCommand command,
    +
    public RegisteredCommand createRegisteredCommand(BaseCommand command,
                                                      String cmdName,
                                                      Method method,
                                                      String prefSubCommand)
    @@ -1071,7 +1126,7 @@ public void 
  • setDefaultExceptionHandler

    -
    public void setDefaultExceptionHandler(ExceptionHandler exceptionHandler)
    +
    public void setDefaultExceptionHandler(ExceptionHandler exceptionHandler)
    Sets the default ExceptionHandler that is called when an exception occurs while executing a command, if the command doesn't have it's own exception handler registered.
    Parameters:
    @@ -1085,7 +1140,7 @@ public void 
  • getDefaultExceptionHandler

    -
    public ExceptionHandler getDefaultExceptionHandler()
    +
    public ExceptionHandler getDefaultExceptionHandler()
    Gets the current default exception handler, might be null.
    Returns:
    @@ -1099,7 +1154,7 @@ public void 
  • handleUncaughtException

    -
    protected boolean handleUncaughtException(BaseCommand scope,
    +
    protected boolean handleUncaughtException(BaseCommand scope,
                                               RegisteredCommand registeredCommand,
                                               CommandIssuer sender,
                                               List<String> args,
    @@ -1114,7 +1169,7 @@ public void 
     
  • sendMessage

    -
    public void sendMessage(IT issuerArg,
    +
    public void sendMessage(IT issuerArg,
                             MessageType type,
                             co.aikar.locales.MessageKeyProvider key,
                             String... replacements)
    @@ -1126,7 +1181,7 @@ public void 
  • sendMessage

    -
    public void sendMessage(CommandIssuer issuer,
    +
    public void sendMessage(CommandIssuer issuer,
                             MessageType type,
                             co.aikar.locales.MessageKeyProvider key,
                             String... replacements)
    @@ -1138,7 +1193,7 @@ public void 
  • formatMessage

    -
    public String formatMessage(CommandIssuer issuer,
    +
    public String formatMessage(CommandIssuer issuer,
                                 MessageType type,
                                 co.aikar.locales.MessageKeyProvider key,
                                 String... replacements)
    @@ -1150,7 +1205,7 @@ public void 
  • onLocaleChange

    -
    public void onLocaleChange(IssuerLocaleChangedCallback<I> onChange)
    +
    public void onLocaleChange(IssuerLocaleChangedCallback<I> onChange)
  • @@ -1161,7 +1216,7 @@ public void 
  • notifyLocaleChange

    -
    public void notifyLocaleChange(I issuer,
    +
    public void notifyLocaleChange(I issuer,
                                    Locale oldLocale,
                                    Locale newLocale)
  • @@ -1174,7 +1229,7 @@ public void 
  • setIssuerLocale

    -
    public Locale setIssuerLocale(IT issuer,
    +
    public Locale setIssuerLocale(IT issuer,
                                   Locale locale)
  • @@ -1184,7 +1239,7 @@ public void 
  • getIssuerLocale

    -
    public Locale getIssuerLocale(CommandIssuer issuer)
    +
    public Locale getIssuerLocale(CommandIssuer issuer)
  • @@ -1193,7 +1248,7 @@ public void 
  • getSupportedLanguages

    -
    public Set<LocalegetSupportedLanguages()
    +
    public Set<LocalegetSupportedLanguages()
    Gets a list of all currently supported languages for this manager. These locales will be automatically loaded from
    @@ -1207,7 +1262,7 @@ public void 
  • addSupportedLanguage

    -
    public void addSupportedLanguage(Locale locale)
    +
    public void addSupportedLanguage(Locale locale)
    Adds a new locale to the list of automatic Locales to load Message Bundles for. All bundles loaded under the previous supported languages will now automatically load for this new locale too.
    @@ -1224,7 +1279,7 @@ public void 
  • registerDependency

    -
    public <T> void registerDependency(Class<? extends T> clazz,
    +
    public <T> void registerDependency(Class<? extends T> clazz,
                                        T instance)
    Registers an instance of a class to be registered as an injectable dependency.
    The command manager will attempt to inject all fields in a command class that are annotated with @@ -1246,7 +1301,7 @@ public void 
  • registerDependency

    -
    public <T> void registerDependency(Class<? extends T> clazz,
    +
    public <T> void registerDependency(Class<? extends T> clazz,
                                        String key,
                                        T instance)
    Registers an instance of a class to be registered as an injectable dependency.
    @@ -1265,15 +1320,24 @@ public void  -
    Deprecated. Use this with caution! If you enable and use Unstable API's, your next compile using ACF may require you to update your implementation to those unstable API's
  • + + + +
  • diff --git a/docs/acf-core/co/aikar/commands/HelpEntry.html b/docs/acf-core/co/aikar/commands/HelpEntry.html index 5af4f6dd..97739851 100644 --- a/docs/acf-core/co/aikar/commands/HelpEntry.html +++ b/docs/acf-core/co/aikar/commands/HelpEntry.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab";


  • -
    public class HelpEntry
    +
    public class HelpEntry
     extends Object
  • @@ -137,22 +137,26 @@ extends getDescription()  +CommandParameter[] +getParameters()  + + String getParameterSyntax()  - + int getSearchScore()  - + String getSearchTags()  - + void setSearchScore(int searchScore)  - + boolean shouldShow()  @@ -184,7 +188,7 @@ extends
  • getCommand

    -
    public String getCommand()
    +
    public String getCommand()
  • @@ -193,7 +197,7 @@ extends
  • getParameterSyntax

    -
    public String getParameterSyntax()
    +
    public String getParameterSyntax()
  • @@ -202,7 +206,7 @@ extends
  • getDescription

    -
    public String getDescription()
    +
    public String getDescription()
  • @@ -211,7 +215,7 @@ extends
  • setSearchScore

    -
    public void setSearchScore(int searchScore)
    +
    public void setSearchScore(int searchScore)
  • @@ -220,7 +224,7 @@ extends
  • shouldShow

    -
    public boolean shouldShow()
    +
    public boolean shouldShow()
  • @@ -229,16 +233,25 @@ extends
  • getSearchScore

    -
    public int getSearchScore()
    +
    public int getSearchScore()
  • -
      + + + + + diff --git a/docs/acf-core/co/aikar/commands/Locales.html b/docs/acf-core/co/aikar/commands/Locales.html index 84c4b11c..1870039f 100644 --- a/docs/acf-core/co/aikar/commands/Locales.html +++ b/docs/acf-core/co/aikar/commands/Locales.html @@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab";


    • -
      public class Locales
      +
      public class Locales
       extends Object
    @@ -290,8 +290,8 @@ extends String -addMessage(Locale locale, - co.aikar.locales.MessageKey key, +addMessage(Locale locale, + co.aikar.locales.MessageKeyProvider key, String message)  @@ -312,7 +312,7 @@ extends void addMessages(Locale locale, - @NotNull Map<co.aikar.locales.MessageKey,String> messages)  + @NotNull Map<? extends co.aikar.locales.MessageKeyProvider,String> messages)  void @@ -374,7 +374,7 @@ extends
  • ENGLISH

    -
    public static final Locale ENGLISH
    +
    public static final Locale ENGLISH
  • @@ -383,7 +383,7 @@ extends
  • GERMAN

    -
    public static final Locale GERMAN
    +
    public static final Locale GERMAN
  • @@ -392,7 +392,7 @@ extends
  • FRENCH

    -
    public static final Locale FRENCH
    +
    public static final Locale FRENCH
  • @@ -401,7 +401,7 @@ extends
  • JAPANESE

    -
    public static final Locale JAPANESE
    +
    public static final Locale JAPANESE
  • @@ -410,7 +410,7 @@ extends
  • ITALIAN

    -
    public static final Locale ITALIAN
    +
    public static final Locale ITALIAN
  • @@ -419,7 +419,7 @@ extends
  • KOREAN

    -
    public static final Locale KOREAN
    +
    public static final Locale KOREAN
  • @@ -428,7 +428,7 @@ extends
  • CHINESE

    -
    public static final Locale CHINESE
    +
    public static final Locale CHINESE
  • @@ -437,7 +437,7 @@ extends
  • SIMPLIFIED_CHINESE

    -
    public static final Locale SIMPLIFIED_CHINESE
    +
    public static final Locale SIMPLIFIED_CHINESE
  • @@ -446,7 +446,7 @@ extends
  • TRADITIONAL_CHINESE

    -
    public static final Locale TRADITIONAL_CHINESE
    +
    public static final Locale TRADITIONAL_CHINESE
  • @@ -455,7 +455,7 @@ extends
  • SPANISH

    -
    public static final Locale SPANISH
    +
    public static final Locale SPANISH
  • @@ -464,7 +464,7 @@ extends
  • DUTCH

    -
    public static final Locale DUTCH
    +
    public static final Locale DUTCH
  • @@ -473,7 +473,7 @@ extends
  • DANISH

    -
    public static final Locale DANISH
    +
    public static final Locale DANISH
  • @@ -482,7 +482,7 @@ extends
  • CZECH

    -
    public static final Locale CZECH
    +
    public static final Locale CZECH
  • @@ -491,7 +491,7 @@ extends
  • GREEK

    -
    public static final Locale GREEK
    +
    public static final Locale GREEK
  • @@ -500,7 +500,7 @@ extends
  • LATIN

    -
    public static final Locale LATIN
    +
    public static final Locale LATIN
  • @@ -509,7 +509,7 @@ extends
  • BULGARIAN

    -
    public static final Locale BULGARIAN
    +
    public static final Locale BULGARIAN
  • @@ -518,7 +518,7 @@ extends
  • AFRIKAANS

    -
    public static final Locale AFRIKAANS
    +
    public static final Locale AFRIKAANS
  • @@ -527,7 +527,7 @@ extends
  • HINDI

    -
    public static final Locale HINDI
    +
    public static final Locale HINDI
  • @@ -536,7 +536,7 @@ extends
  • HEBREW

    -
    public static final Locale HEBREW
    +
    public static final Locale HEBREW
  • @@ -545,7 +545,7 @@ extends
  • POLISH

    -
    public static final Locale POLISH
    +
    public static final Locale POLISH
  • @@ -554,7 +554,7 @@ extends
  • PORTUGUESE

    -
    public static final Locale PORTUGUESE
    +
    public static final Locale PORTUGUESE
  • @@ -563,7 +563,7 @@ extends
  • FINNISH

    -
    public static final Locale FINNISH
    +
    public static final Locale FINNISH
  • @@ -572,7 +572,7 @@ extends
  • SWEDISH

    -
    public static final Locale SWEDISH
    +
    public static final Locale SWEDISH
  • @@ -581,7 +581,7 @@ extends
  • RUSSIAN

    -
    public static final Locale RUSSIAN
    +
    public static final Locale RUSSIAN
  • @@ -590,7 +590,7 @@ extends
  • ROMANIAN

    -
    public static final Locale ROMANIAN
    +
    public static final Locale ROMANIAN
  • @@ -599,7 +599,7 @@ extends
  • VIETNAMESE

    -
    public static final Locale VIETNAMESE
    +
    public static final Locale VIETNAMESE
  • @@ -608,7 +608,7 @@ extends
  • THAI

    -
    public static final Locale THAI
    +
    public static final Locale THAI
  • @@ -617,7 +617,7 @@ extends
  • TURKISH

    -
    public static final Locale TURKISH
    +
    public static final Locale TURKISH
  • @@ -626,7 +626,7 @@ extends
  • UKRANIAN

    -
    public static final Locale UKRANIAN
    +
    public static final Locale UKRANIAN
  • @@ -635,7 +635,7 @@ extends
  • ARABIC

    -
    public static final Locale ARABIC
    +
    public static final Locale ARABIC
  • @@ -644,7 +644,7 @@ extends
  • WELSH

    -
    public static final Locale WELSH
    +
    public static final Locale WELSH
  • @@ -661,7 +661,7 @@ extends
  • Locales

    -
    public Locales(CommandManager manager)
    +
    public Locales(CommandManager manager)
  • @@ -678,7 +678,7 @@ extends
  • loadLanguages

    -
    public void loadLanguages()
    +
    public void loadLanguages()
  • @@ -687,7 +687,7 @@ extends
  • getDefaultLocale

    -
    public Locale getDefaultLocale()
    +
    public Locale getDefaultLocale()
  • @@ -696,7 +696,7 @@ extends
  • setDefaultLocale

    -
    public Locale setDefaultLocale(Locale locale)
    +
    public Locale setDefaultLocale(Locale locale)
  • @@ -705,7 +705,7 @@ extends
  • loadMissingBundles

    -
    public void loadMissingBundles()
    +
    public void loadMissingBundles()
    Looks for all previously loaded bundles, and if any new Supported Languages have been added, load them.
  • @@ -715,7 +715,7 @@ extends
  • addMessageBundles

    -
    public void addMessageBundles(String... bundleNames)
    +
    public void addMessageBundles(String... bundleNames)
  • @@ -724,7 +724,7 @@ extends
  • addMessageBundle

    -
    public boolean addMessageBundle(String bundleName,
    +
    public boolean addMessageBundle(String bundleName,
                                     Locale locale)
  • @@ -734,7 +734,7 @@ extends
  • addMessageBundle

    -
    public boolean addMessageBundle(ClassLoader classLoader,
    +
    public boolean addMessageBundle(ClassLoader classLoader,
                                     String bundleName,
                                     Locale locale)
  • @@ -745,7 +745,7 @@ extends
  • addMessageStrings

    -
    public void addMessageStrings(Locale locale,
    +
    public void addMessageStrings(Locale locale,
                                   @NotNull
                                   @NotNull Map<String,String> messages)
  • @@ -756,19 +756,19 @@ extends
  • addMessages

    -
    public void addMessages(Locale locale,
    +
    public void addMessages(Locale locale,
                             @NotNull
    -                        @NotNull Map<co.aikar.locales.MessageKey,String> messages)
    + @NotNull Map<? extends co.aikar.locales.MessageKeyProvider,String> messages)
  • - + @@ -778,7 +778,7 @@ extends
  • getMessage

    -
    public String getMessage(CommandIssuer issuer,
    +
    public String getMessage(CommandIssuer issuer,
                              co.aikar.locales.MessageKeyProvider key)
  • @@ -788,7 +788,7 @@ extends
  • replaceI18NStrings

    -
    public String replaceI18NStrings(String message)
    +
    public String replaceI18NStrings(String message)
  • @@ -797,7 +797,7 @@ extends
  • addBundleClassLoader

    -
    public boolean addBundleClassLoader(ClassLoader classLoader)
    +
    public boolean addBundleClassLoader(ClassLoader classLoader)
  • diff --git a/docs/acf-core/co/aikar/commands/MessageKeys.html b/docs/acf-core/co/aikar/commands/MessageKeys.html index e6c9e2e6..bfca4110 100644 --- a/docs/acf-core/co/aikar/commands/MessageKeys.html +++ b/docs/acf-core/co/aikar/commands/MessageKeys.html @@ -151,14 +151,26 @@ implements co.aikar.locales.MessageKeyProvider
    ERROR_PREFIX  +HELP_DETAILED_HEADER  + + +HELP_DETAILED_PARAMETER_FORMAT  + + HELP_FORMAT  -HELP_NO_RESULTS  +HELP_HEADER  +HELP_NO_RESULTS  + + HELP_PAGE_INFORMATION  + +HELP_SEARCH_HEADER  + INFO_MESSAGE  @@ -391,22 +403,13 @@ the order they are declared.
  • public static final MessageKeys COULD_NOT_FIND_PLAYER
    - - - - @@ -415,16 +418,61 @@ the order they are declared. -