BladeConfiguration (core 1.0.23 API)

java.lang.Object
- me.vaperion.blade.platform.BladeConfiguration<Text>

public final class BladeConfiguration<Text>
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

BladeConfiguration()

Constructors
Constructor and Description
`BladeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.function.Consumer<java.lang.Runnable>`	`asyncExecutor()` The executor used for running asynchronous commands (commands annotated with `Async`).
`BladeConfiguration<Text>`	`asyncExecutor(java.util.function.Consumer<java.lang.Runnable> asyncExecutor)` The executor used for running asynchronous commands (commands annotated with `Async`).
`java.lang.String`	`commandQualifier()` The qualifier used to register commands.
`BladeConfiguration<Text>`	`commandQualifier(java.lang.String commandQualifier)` The qualifier used to register commands.
`java.lang.String`	`defaultPermissionMessage()` The default permission message sent to users when they don't have permission to execute a command.
`BladeConfiguration<Text>`	`defaultPermissionMessage(java.lang.String defaultPermissionMessage)` The default permission message sent to users when they don't have permission to execute a command.
`long`	`executionTimeWarningThreshold()` The execution time threshold (in milliseconds) after which a warning is logged when a command takes too long to execute on the main thread.
`BladeConfiguration<Text>`	`executionTimeWarningThreshold(long executionTimeWarningThreshold)` The execution time threshold (in milliseconds) after which a warning is logged when a command takes too long to execute on the main thread.
`CommandFeedbackCreator<Text>`	`feedbackCreator()` The creator used for generating command feedback messages (usage and help).
`BladeConfiguration<Text>`	`feedbackCreator(CommandFeedbackCreator<Text> feedbackCreator)` The creator used for generating command feedback messages (usage and help).
`HelpGenerator<Text>`	`helpGenerator()` The help generator used for generating help messages for commands.
`BladeConfiguration<Text>`	`helpGenerator(HelpGenerator<Text> helpGenerator)` The help generator used for generating help messages for commands.
`java.util.Comparator<BladeCommand>`	`helpSorter()` The comparator used to sort commands in help messages.
`BladeConfiguration<Text>`	`helpSorter(java.util.Comparator<BladeCommand> helpSorter)` The comparator used to sort commands in help messages.
`boolean`	`lenientFlagMatching()` Whether Blade should strictly match flags when parsing command arguments.
`BladeConfiguration<Text>`	`lenientFlagMatching(boolean lenientFlagMatching)` Whether Blade should strictly match flags when parsing command arguments.
`BladeLogger`	`logger()` The logger Blade uses to log messages, warnings and errors.
`BladeConfiguration<Text>`	`logger(BladeLogger logger)` The logger Blade uses to log messages, warnings and errors.
`boolean`	`overrideCommands()` Whether Blade should override vanilla commands when registering commands with the same name.
`BladeConfiguration<Text>`	`overrideCommands(boolean overrideCommands)` Whether Blade should override vanilla commands when registering commands with the same name.
`boolean`	`strictArgumentCount()` Whether Blade should strictly enforce the argument count when executing commands.
`BladeConfiguration<Text>`	`strictArgumentCount(boolean strictArgumentCount)` Whether Blade should strictly enforce the argument count when executing commands.
`boolean`	`strictFlagCount()` Whether Blade should strictly enforce that each flag is only provided once.
`BladeConfiguration<Text>`	`strictFlagCount(boolean strictFlagCount)` Whether Blade should strictly enforce that each flag is only provided once.
`TabCompleter`	`tabCompleter()` The tab completer used for providing command completions.
`BladeConfiguration<Text>`	`tabCompleter(TabCompleter tabCompleter)` The tab completer used for providing command completions.
`void`	`validate()`
`boolean`	`verbose()` Whether Blade should log verbose output.
`BladeConfiguration<Text>`	`verbose(boolean verbose)` Whether Blade should log verbose output.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BladeConfiguration
```
public BladeConfiguration()
```
- Method Detail
  - validate
```
public void validate()
```
  - verbose
```
public BladeConfiguration<Text> verbose(boolean verbose)
```
    Whether Blade should log verbose output.
    This includes detailed information like command registration.
    
    Returns:
    
    this.
  - overrideCommands
```
public BladeConfiguration<Text> overrideCommands(boolean overrideCommands)
```
    Whether Blade should override vanilla commands when registering commands with the same name.
    For example, if you register a command named whitelist, the vanilla /whitelist command will be overridden if this option is enabled.
    
    Returns:
    
    this.
  - commandQualifier
```
public BladeConfiguration<Text> commandQualifier(java.lang.String commandQualifier)
```
    The qualifier used to register commands.
    Most platforms (Bukkit, Velocity, etc.) prefix commands with the plugin name. As an example, you can access the plugins command in Bukkit using /bukkit:plugins as well as /plugins.
    By default, this is set to your plugin's name.
    
    Returns:
    
    this.
  - defaultPermissionMessage
```
public BladeConfiguration<Text> defaultPermissionMessage(java.lang.String defaultPermissionMessage)
```
    The default permission message sent to users when they don't have permission to execute a command.
    This can be overridden on a per-command basis using the Permission annotation.
    
    Returns:
    
    this.
  - executionTimeWarningThreshold
```
public BladeConfiguration<Text> executionTimeWarningThreshold(long executionTimeWarningThreshold)
```
    The execution time threshold (in milliseconds) after which a warning is logged when a command takes too long to execute on the main thread.
    
    Returns:
    
    this.
  - strictArgumentCount
```
public BladeConfiguration<Text> strictArgumentCount(boolean strictArgumentCount)
```
    Whether Blade should strictly enforce the argument count when executing commands.
    When enabled (default), if a user provides more arguments than a command expects, Blade will reject the command execution and inform the user about the incorrect argument count.
    
    Returns:
    
    this.
  - lenientFlagMatching
```
public BladeConfiguration<Text> lenientFlagMatching(boolean lenientFlagMatching)
```
    Whether Blade should strictly match flags when parsing command arguments.
    When disabled (default), any unknown flags that are encountered will be parsed as standard arguments. This also applies to BSD-style flags, e.g. -ab will be parsed as an argument if either -a or -b are unknown.
    When enabled, unknown flags will simply be ignored during parsing.
    
    Returns:
    
    this.
  - strictFlagCount
```
public BladeConfiguration<Text> strictFlagCount(boolean strictFlagCount)
```
    Whether Blade should strictly enforce that each flag is only provided once.
    When enabled (default), if a user provides the same flag multiple times, Blade will reject the command execution and inform the user about the duplicate flags.
    
    Returns:
    
    this.
  - asyncExecutor
```
public BladeConfiguration<Text> asyncExecutor(java.util.function.Consumer<java.lang.Runnable> asyncExecutor)
```
    The executor used for running asynchronous commands (commands annotated with Async).
    
    Returns:
    
    this.
  - tabCompleter
```
public BladeConfiguration<Text> tabCompleter(TabCompleter tabCompleter)
```
    The tab completer used for providing command completions.
    By default, a platform-specific implementation is used.
    
    Returns:
    
    this.
  - helpGenerator
```
public BladeConfiguration<Text> helpGenerator(HelpGenerator<Text> helpGenerator)
```
    The help generator used for generating help messages for commands.
    
    Returns:
    
    this.
  - feedbackCreator
```
public BladeConfiguration<Text> feedbackCreator(CommandFeedbackCreator<Text> feedbackCreator)
```
    The creator used for generating command feedback messages (usage and help).
    
    Returns:
    
    this.
  - logger
```
public BladeConfiguration<Text> logger(BladeLogger logger)
```
    The logger Blade uses to log messages, warnings and errors.
    
    Returns:
    
    this.
  - helpSorter
```
public BladeConfiguration<Text> helpSorter(java.util.Comparator<BladeCommand> helpSorter)
```
    The comparator used to sort commands in help messages.
    By default, commands are sorted alphabetically by their main label.
    
    Returns:
    
    this.
  - verbose
```
public boolean verbose()
```
    Whether Blade should log verbose output.
    This includes detailed information like command registration.
  - overrideCommands
```
public boolean overrideCommands()
```
    Whether Blade should override vanilla commands when registering commands with the same name.
    For example, if you register a command named whitelist, the vanilla /whitelist command will be overridden if this option is enabled.
  - commandQualifier
```
public java.lang.String commandQualifier()
```
    The qualifier used to register commands.
    Most platforms (Bukkit, Velocity, etc.) prefix commands with the plugin name. As an example, you can access the plugins command in Bukkit using /bukkit:plugins as well as /plugins.
    By default, this is set to your plugin's name.
  - defaultPermissionMessage
```
public java.lang.String defaultPermissionMessage()
```
    The default permission message sent to users when they don't have permission to execute a command.
    This can be overridden on a per-command basis using the Permission annotation.
  - executionTimeWarningThreshold
```
public long executionTimeWarningThreshold()
```
    The execution time threshold (in milliseconds) after which a warning is logged when a command takes too long to execute on the main thread.
  - strictArgumentCount
```
public boolean strictArgumentCount()
```
    Whether Blade should strictly enforce the argument count when executing commands.
    When enabled (default), if a user provides more arguments than a command expects, Blade will reject the command execution and inform the user about the incorrect argument count.
  - lenientFlagMatching
```
public boolean lenientFlagMatching()
```
    Whether Blade should strictly match flags when parsing command arguments.
    When disabled (default), any unknown flags that are encountered will be parsed as standard arguments. This also applies to BSD-style flags, e.g. -ab will be parsed as an argument if either -a or -b are unknown.
    When enabled, unknown flags will simply be ignored during parsing.
  - strictFlagCount
```
public boolean strictFlagCount()
```
    Whether Blade should strictly enforce that each flag is only provided once.
    When enabled (default), if a user provides the same flag multiple times, Blade will reject the command execution and inform the user about the duplicate flags.
  - asyncExecutor
```
public java.util.function.Consumer<java.lang.Runnable> asyncExecutor()
```
    The executor used for running asynchronous commands (commands annotated with Async).
  - tabCompleter
```
public TabCompleter tabCompleter()
```
    The tab completer used for providing command completions.
    By default, a platform-specific implementation is used.
  - helpGenerator
```
public HelpGenerator<Text> helpGenerator()
```
    The help generator used for generating help messages for commands.
  - feedbackCreator
```
public CommandFeedbackCreator<Text> feedbackCreator()
```
    The creator used for generating command feedback messages (usage and help).
  - logger
```
public BladeLogger logger()
```
    The logger Blade uses to log messages, warnings and errors.
  - helpSorter
```
public java.util.Comparator<BladeCommand> helpSorter()
```
    The comparator used to sort commands in help messages.
    By default, commands are sorted alphabetically by their main label.

Class BladeConfiguration<Text>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BladeConfiguration

Method Detail

validate

verbose

overrideCommands

commandQualifier

defaultPermissionMessage

executionTimeWarningThreshold

strictArgumentCount

lenientFlagMatching

strictFlagCount

asyncExecutor

tabCompleter

helpGenerator

feedbackCreator

logger

helpSorter

verbose

overrideCommands

commandQualifier

defaultPermissionMessage

executionTimeWarningThreshold

strictArgumentCount

lenientFlagMatching

strictFlagCount

asyncExecutor

tabCompleter

helpGenerator

feedbackCreator

logger

helpSorter