FunctionalCommandBuilder (helper 5.6.2 API)

Type Parameters:: T - the sender type

@NonnullByDefault
public interface FunctionalCommandBuilder<T extends CommandSender>

Functional builder API for Command

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_INVALID_ARGUMENT_MESSAGE`
`static String`	`DEFAULT_INVALID_SENDER_MESSAGE`
`static String`	`DEFAULT_INVALID_USAGE_MESSAGE`
`static String`	`DEFAULT_NOT_CONSOLE_MESSAGE`
`static String`	`DEFAULT_NOT_OP_MESSAGE`
`static String`	`DEFAULT_NOT_PLAYER_MESSAGE`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default FunctionalCommandBuilder<T>`	`assertArgument(int index, Predicate<String> test)` Tests a given argument with the provided predicate.
`FunctionalCommandBuilder<T>`	`assertArgument(int index, Predicate<String> test, String failureMessage)` Tests a given argument with the provided predicate.
`default FunctionalCommandBuilder<ConsoleCommandSender>`	`assertConsole()` Asserts that the sender is instance of ConsoleCommandSender, and sends them the default failure message if they're not.
`FunctionalCommandBuilder<ConsoleCommandSender>`	`assertConsole(String failureMessage)` Asserts that the sender is instance of ConsoleCommandSender, and sends them the failure message if they're not
`default FunctionalCommandBuilder<T>`	`assertOp()` Asserts that the sender is op, and sends them the default failure message if they're not.
`FunctionalCommandBuilder<T>`	`assertOp(String failureMessage)` Asserts that the sender is op, and sends them the failure message if they don't have permission
`default FunctionalCommandBuilder<T>`	`assertPermission(String permission)` Asserts that the sender has the specified permission, and sends them the default failure message if they don't have permission.
`FunctionalCommandBuilder<T>`	`assertPermission(String permission, String failureMessage)` Asserts that the sender has the specified permission, and sends them the failure message if they don't have permission.
`default FunctionalCommandBuilder<Player>`	`assertPlayer()` Asserts that the sender is instance of Player, and sends them the default failure message if they're not.
`FunctionalCommandBuilder<Player>`	`assertPlayer(String failureMessage)` Asserts that the sender is instance of Player, and sends them the failure message if they're not
`default FunctionalCommandBuilder<T>`	`assertSender(Predicate<T> test)` Tests the sender with the provided predicate.
`FunctionalCommandBuilder<T>`	`assertSender(Predicate<T> test, String failureMessage)` Tests the sender with the provided predicate.
`default FunctionalCommandBuilder<T>`	`assertUsage(String usage)` Asserts that the arguments match the given usage string.
`FunctionalCommandBuilder<T>`	`assertUsage(String usage, String failureMessage)` Asserts that the arguments match the given usage string.
`FunctionalCommandBuilder<T>`	`description(String description)` Sets the command description to the specified one.
`Command`	`handler(FunctionalCommandHandler<T> handler)` Builds this `FunctionalCommandBuilder` into a `Command` instance.
`static FunctionalCommandBuilder<CommandSender>`	`newBuilder()`

- Field Detail
  - DEFAULT_NOT_OP_MESSAGE
```
static final String DEFAULT_NOT_OP_MESSAGE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_NOT_PLAYER_MESSAGE
```
static final String DEFAULT_NOT_PLAYER_MESSAGE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_NOT_CONSOLE_MESSAGE
```
static final String DEFAULT_NOT_CONSOLE_MESSAGE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INVALID_USAGE_MESSAGE
```
static final String DEFAULT_INVALID_USAGE_MESSAGE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INVALID_ARGUMENT_MESSAGE
```
static final String DEFAULT_INVALID_ARGUMENT_MESSAGE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INVALID_SENDER_MESSAGE
```
static final String DEFAULT_INVALID_SENDER_MESSAGE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - newBuilder
```
static FunctionalCommandBuilder<CommandSender> newBuilder()
```
  - description
```
FunctionalCommandBuilder<T> description(String description)
```
    Sets the command description to the specified one.
    
    Parameters:
    
    description - the command description
    
    Returns:
    
    the builder instance
  - assertPermission
```
default FunctionalCommandBuilder<T> assertPermission(String permission)
```
    Asserts that the sender has the specified permission, and sends them the default failure message if they don't have permission.
    
    Parameters:
    
    permission - the permission to check for
    
    Returns:
    
    the builder instance
  - assertPermission
```
FunctionalCommandBuilder<T> assertPermission(String permission,
                                             @Nullable
                                             String failureMessage)
```
    Asserts that the sender has the specified permission, and sends them the failure message if they don't have permission.
    
    Parameters:
    
    permission - the permission to check for
    
    failureMessage - the failure message to send if they don't have permission
    
    Returns:
    
    the builder instance
  - assertOp
```
default FunctionalCommandBuilder<T> assertOp()
```
    Asserts that the sender is op, and sends them the default failure message if they're not.
    
    Returns:
    
    the builder instance
  - assertOp
```
FunctionalCommandBuilder<T> assertOp(String failureMessage)
```
    Asserts that the sender is op, and sends them the failure message if they don't have permission
    
    Parameters:
    
    failureMessage - the failure message to send if they're not op
    
    Returns:
    
    the builder instance
  - assertPlayer
```
default FunctionalCommandBuilder<Player> assertPlayer()
```
    Asserts that the sender is instance of Player, and sends them the default failure message if they're not.
    
    Returns:
    
    the builder instance
  - assertPlayer
```
FunctionalCommandBuilder<Player> assertPlayer(String failureMessage)
```
    Asserts that the sender is instance of Player, and sends them the failure message if they're not
    
    Parameters:
    
    failureMessage - the failure message to send if they're not a player
    
    Returns:
    
    the builder instance
  - assertConsole
```
default FunctionalCommandBuilder<ConsoleCommandSender> assertConsole()
```
    Asserts that the sender is instance of ConsoleCommandSender, and sends them the default failure message if they're not.
    
    Returns:
    
    the builder instance
  - assertConsole
```
FunctionalCommandBuilder<ConsoleCommandSender> assertConsole(String failureMessage)
```
    Asserts that the sender is instance of ConsoleCommandSender, and sends them the failure message if they're not
    
    Parameters:
    
    failureMessage - the failure message to send if they're not console
    
    Returns:
    
    the builder instance
  - assertUsage
```
default FunctionalCommandBuilder<T> assertUsage(String usage)
```
    Asserts that the arguments match the given usage string. Arguments should be separated by a " " space. Optional arguments are denoted by wrapping the argument name in square quotes "[ ]" The default failure message is sent if they didn't provide enough arguments.
    
    Parameters:
    
    usage - the usage string
    
    Returns:
    
    the builder instance
  - assertUsage
```
FunctionalCommandBuilder<T> assertUsage(String usage,
                                        String failureMessage)
```
    Asserts that the arguments match the given usage string. Arguments should be separated by a " " space. Optional arguments are denoted by wrapping the argument name in square quotes "[ ]" The failure message is sent if they didn't provide enough arguments. "{usage}" in this message will be replaced by the usage for the command.
    
    Parameters:
    
    usage - the usage string
    
    failureMessage - the failure message to send if the arguments to not match the usage
    
    Returns:
    
    the builder instance
  - assertArgument
```
default FunctionalCommandBuilder<T> assertArgument(int index,
                                                   Predicate<String> test)
```
    Tests a given argument with the provided predicate. The default failure message is sent if the argument does not pass the predicate. If the argument is not present at the given index, null is passed to the predicate.
    
    Parameters:
    
    index - the index of the argument to test
    
    test - the test predicate
    
    Returns:
    
    the builder instance
  - assertArgument
```
FunctionalCommandBuilder<T> assertArgument(int index,
                                           Predicate<String> test,
                                           String failureMessage)
```
    Tests a given argument with the provided predicate. The failure message is sent if the argument does not pass the predicate. If the argument is not present at the given index, null is passed to the predicate. "{arg}" and "{index}" will be replaced in the failure message with the index and actual argument value respectively.
    
    Parameters:
    
    index - the index of the argument to test
    
    test - the test predicate
    
    failureMessage - the failure message to send if the predicate fails
    
    Returns:
    
    the builder instance
  - assertSender
```
default FunctionalCommandBuilder<T> assertSender(Predicate<T> test)
```
    Tests the sender with the provided predicate. The default failure message is sent if the sender does not pass the predicate.
    
    Parameters:
    
    test - the test predicate
    
    Returns:
    
    the builder instance
  - assertSender
```
FunctionalCommandBuilder<T> assertSender(Predicate<T> test,
                                         String failureMessage)
```
    Tests the sender with the provided predicate. The failure message is sent if the sender does not pass the predicate.
    
    Parameters:
    
    test - the test predicate
    
    failureMessage - the failure message to send if the predicate fails
    
    Returns:
    
    the builder instance
  - handler
```
Command handler(FunctionalCommandHandler<T> handler)
```
    Builds this FunctionalCommandBuilder into a Command instance. The command will not be registered with the server until Command.register(String...) is called.
    
    Parameters:
    
    handler - the command handler
    
    Returns:
    
    the command instance.

Interface FunctionalCommandBuilder<T extends CommandSender>

Field Summary

Method Summary

Field Detail

DEFAULT_NOT_OP_MESSAGE

DEFAULT_NOT_PLAYER_MESSAGE

DEFAULT_NOT_CONSOLE_MESSAGE

DEFAULT_INVALID_USAGE_MESSAGE

DEFAULT_INVALID_ARGUMENT_MESSAGE

DEFAULT_INVALID_SENDER_MESSAGE

Method Detail

newBuilder

description

assertPermission

assertPermission

assertOp

assertOp

assertPlayer

assertPlayer

assertConsole

assertConsole

assertUsage

assertUsage

assertArgument

assertArgument

assertSender

assertSender

handler