Package dev.sympho.modular_commands.utils

Class CommandUtils

java.lang.Object

dev.sympho.modular_commands.utils.CommandUtils

public final class CommandUtils
extends Object

Utility functions for Commands.

Since:

1.0

Version:

1.0

Method Summary

Modifier and Type	Method	Description
static void	validateAlias(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String alias)	Validates an alias.
static void	validateAliases(Set<@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String> aliases)	Validates the aliases of a command.
static void	validateCommand(Command<?> command)	Validates a command.
static void	validateDescription(@MatchesRegex("(?Us)^.{1,100}+$") String description)	Validates the description of a command.
static void	validateDisplayName(@MatchesRegex("(?U)^[ -_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)	Validates the display name of a command.
static void	validateGroup(Group group)	Validates the required group of a command.
static void	validateHandlers(Handlers handlers)	Validates the handlers of a command.
static void	validateId(String id)	Validates the ID of a command.
static void	validateInvocationHandler(InvocationHandler<?> handler)	Validates the invocation handler of a command.
static void	validateName(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)	Validates the name of a command.
static void	validateParameters(List<Parameter<?>> parameters)	Validates the parameters of a command.
static void	validateParent(Invocation parent)	Validates the parent of a command.
static void	validateResultHandlers(List<? extends ResultHandler<?>> handlers)	Validates the result handlers of a command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

validateId

@SideEffectFree
public static void validateId(String id)
                       throws NullPointerException

Validates the ID of a command.

Parameters:

id - The ID to validate.

Throws:

NullPointerException - if a null value was found where not allowed.

validateParent

@SideEffectFree
public static void validateParent(Invocation parent)
                           throws IllegalArgumentException,
NullPointerException

Validates the parent of a command.

Parameters:

parent - The parent to validate.

Throws:

IllegalArgumentException - if the parent is not valid.

NullPointerException - if a null value was found where not allowed.

validateName

@SideEffectFree
public static void validateName(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)
                         throws IllegalArgumentException,
NullPointerException

Validates the name of a command.

Parameters:

name - The name to validate.

Throws:

IllegalArgumentException - if the name is not valid.

NullPointerException - if a null value was found where not allowed.

validateDisplayName

@SideEffectFree
public static void validateDisplayName(@MatchesRegex("(?U)^[ -_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)
                                throws IllegalArgumentException,
NullPointerException

Validates the display name of a command.

Parameters:

name - The display name to validate.

Throws:

IllegalArgumentException - if the display name is not valid.

NullPointerException - if a null value was found where not allowed.

validateAlias

@SideEffectFree
public static void validateAlias(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String alias)
                          throws IllegalArgumentException,
NullPointerException

Validates an alias.

Parameters:

alias - The alias to validate.

Throws:

IllegalArgumentException - if the alias is not valid.

NullPointerException - if a null value was found where not allowed.

validateAliases

@SideEffectFree
public static void validateAliases(Set<@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String> aliases)
                            throws IllegalArgumentException,
NullPointerException

Validates the aliases of a command.

Parameters:

aliases - The aliases to validate.

Throws:

IllegalArgumentException - if the alias set is not valid.

NullPointerException - if a null value was found where not allowed.

validateDescription

@SideEffectFree
public static void validateDescription(@MatchesRegex("(?Us)^.{1,100}+$") String description)
                                throws IllegalArgumentException,
NullPointerException

Validates the description of a command.

Parameters:

description - The description to validate.

Throws:

IllegalArgumentException - if the description is not valid.

NullPointerException - if a null value was found where not allowed.

validateParameters

@SideEffectFree
public static void validateParameters(List<Parameter<?>> parameters)
                               throws IllegalArgumentException,
NullPointerException

Validates the parameters of a command.

Parameters:

parameters - The parameters to validate.

Throws:

IllegalArgumentException - if the parameter list is not valid.

NullPointerException - if a null value was found where not allowed.

validateGroup

@SideEffectFree
public static void validateGroup(Group group)
                          throws NullPointerException

Validates the required group of a command.

Parameters:

group - The group to validate.

Throws:

NullPointerException - if a null value was found where not allowed.

validateInvocationHandler

@SideEffectFree
public static void validateInvocationHandler(InvocationHandler<?> handler)
                                      throws NullPointerException

Validates the invocation handler of a command.

Parameters:

handler - The handler to validate.

Throws:

NullPointerException - if a null value was found where not allowed.

validateResultHandlers

@SideEffectFree
public static void validateResultHandlers(List<? extends ResultHandler<?>> handlers)
                                   throws NullPointerException

Validates the result handlers of a command.

Parameters:

handlers - The result handlers to validate.

Throws:

NullPointerException - if a null value was found where not allowed.

validateHandlers

@SideEffectFree
public static void validateHandlers(Handlers handlers)
                             throws NullPointerException

Validates the handlers of a command.

Parameters:

handlers - The handlers to validate.

Throws:

NullPointerException - if a null value was found where not allowed.

validateCommand

@SideEffectFree
public static void validateCommand(Command<?> command)
                            throws IllegalArgumentException

Validates a command.

Parameters:

command - The command to validate.

Throws:

IllegalArgumentException - if any of the components of the command was invalid.

NullPointerException - if a null value was found where not allowed.