Package dev.sympho.modular_commands.utils.builder

Class CommandBuilder<H extends Handlers>

java.lang.Object

dev.sympho.modular_commands.utils.builder.CommandBuilder<H>

Type Parameters:

H - The handler type.

public final class CommandBuilder<H extends Handlers>
extends Object

Builder for commands.

Since:

1.0

Version:

1.0

See Also:

• Command

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String>	aliases	The command aliases.
protected boolean	callable	Whether the command can be invoked directly.
static final boolean	DEFAULT_CALLABLE	Default for withCallable(boolean).
static final ReplyManager.EphemeralType	DEFAULT_EPHEMERAL	Default for setEphemeralReply(EphemeralType) (ReplyManager.EphemeralType.NONE).
static final Group	DEFAULT_GROUP	Default for requireGroup(Group) (Groups.EVERYONE).
static final boolean	DEFAULT_INHERIT	Default for setInheritSettings(boolean).
static final boolean	DEFAULT_INVOKE_PARENT	Default for setInvokeParent(boolean).
static final boolean	DEFAULT_NSFW	Default for setNsfw(boolean).
static final boolean	DEFAULT_PRIVATE	Default for setPrivateReply(boolean).
static final boolean	DEFAULT_REQUIRE_PARENT_GROUPS	Default for setRequireParentGroups(boolean).
static final Command.Scope	DEFAULT_SCOPE	Default for withScope(Scope) (Command.Scope.GLOBAL).
static final boolean	DEFAULT_SKIP	Default for setSkipGroupCheckOnInteraction(boolean).
protected @MonotonicNonNull @MatchesRegex("(?Us)^.{1,100}+$") String	description	The command description.
protected @MonotonicNonNull @MatchesRegex("(?U)^[ -_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String	displayName	The display name.
protected ReplyManager.EphemeralType	ephemeralReply	The type of ephemeral response to use, if any.
protected @MonotonicNonNull H	handlers	The handlers to process invocations with.
protected boolean	inheritSettings	Whether to inherit settings from parent.
protected boolean	invokeParent	Whether to execute the parent.
protected @MonotonicNonNull @MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String	name	The command name.
protected boolean	nsfw	Whether the command can only be run in NSFW channels.
protected List<Parameter<?>>	parameters	The command parameters.
protected Invocation	parent	The command parent.
protected boolean	privateReply	Whether the command response should only be seen by the caller.
protected Group	requiredGroup	The group that a user must have access for.
protected boolean	requireParentGroups	Whether to also require the parent command's groups.
protected Command.Scope	scope	The command scope.
protected boolean	skipGroupCheckOnInteraction	Whether group access checking should be skipped.

Constructor Summary

Constructors

Constructor	Description
CommandBuilder()	Constructs a new builder with default values.
CommandBuilder(CommandBuilder<? extends H> base)	Constructs a new builder that is a copy of the given builder.

Method Summary

Modifier and Type	Method	Description
CommandBuilder<H>	addAliases(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String... aliases)	Adds aliases to the command.
CommandBuilder<H>	addParameter(Parameter<?> parameter)	Adds a parameter to the command.
Command<H>	build()	Builds the configured command.
static <H extends Handlers> CommandBuilder<H>	from(Command<H> base)	Constructs a new builder that is initialized to make a copy of the given command.
static CommandBuilder<InteractionHandlers>	interaction()	Creates a builder for an interaction command.
static CommandBuilder<MessageHandlers>	message()	Creates a builder for a message-only command.
CommandBuilder<H>	noAliases()	Removes all aliases from the command.
CommandBuilder<H>	noParameters()	Removes all parameters from the command.
CommandBuilder<H>	requireGroup(@Nullable Group group)	Sets the group that a user must have access for.
CommandBuilder<H>	setEphemeralReply(@Nullable ReplyManager.EphemeralType ephemeralReply)	Sets the type of ephemeral response to use, if any.
CommandBuilder<H>	setInheritSettings(boolean inheritSettings)	Sets whether the command should inherit settings from the parent command.
CommandBuilder<H>	setInvokeParent(boolean invokeParent)	Sets whether the command should also invoke the parent's handler.
CommandBuilder<H>	setNsfw(boolean nsfw)	Sets whether the command can only be run in channels marked as NSFW.
CommandBuilder<H>	setPrivateReply(boolean privateReply)	Sets whether the command response should be sent privately to the caller.
CommandBuilder<H>	setRequireParentGroups(boolean require)	Sets whether the command also require its parent command's groups.
CommandBuilder<H>	setSkipGroupCheckOnInteraction(boolean skip)	Sets whether group access checking should be skipped.
static CommandBuilder<SlashHandlers>	slash()	Creates a builder for a slash-only command.
static CommandBuilder<TextHandlers>	text()	Creates a builder for a text (message and slash) command.
CommandBuilder<H>	withAliases(@Nullable Set<@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String> aliases)	Sets the aliases that a user should support.
CommandBuilder<H>	withCallable(boolean callable)	Sets whether the command can be invoked directly.
CommandBuilder<H>	withDescription(@MatchesRegex("(?Us)^.{1,100}+$") String description)	Sets the description of the command.
CommandBuilder<H>	withDisplayName(@MatchesRegex("(?U)^[ -_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)	Sets the display name of the command.
CommandBuilder<H>	withHandlers(H handlers)	Sets the handlers of the command.
CommandBuilder<H>	withName(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)	Sets the name of the command.
CommandBuilder<H>	withParameters(@Nullable List<Parameter<?>> parameters)	Sets the parameters that a user should provide.
CommandBuilder<H>	withParent(@Nullable Invocation parent)	Sets the parent command.
CommandBuilder<H>	withScope(@Nullable Command.Scope scope)	Sets the command scope.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SCOPE

public static final Command.Scope DEFAULT_SCOPE

Default for withScope(Scope) (Command.Scope.GLOBAL).

DEFAULT_CALLABLE

public static final boolean DEFAULT_CALLABLE

Default for withCallable(boolean).

See Also:

• Constant Field Values

DEFAULT_GROUP

public static final Group DEFAULT_GROUP

Default for requireGroup(Group) (Groups.EVERYONE).

DEFAULT_SKIP

public static final boolean DEFAULT_SKIP

Default for setSkipGroupCheckOnInteraction(boolean).

See Also:

• Constant Field Values

DEFAULT_REQUIRE_PARENT_GROUPS

public static final boolean DEFAULT_REQUIRE_PARENT_GROUPS

Default for setRequireParentGroups(boolean).

See Also:

• Constant Field Values

DEFAULT_NSFW

public static final boolean DEFAULT_NSFW

Default for setNsfw(boolean).

See Also:

• Constant Field Values

DEFAULT_PRIVATE

public static final boolean DEFAULT_PRIVATE

Default for setPrivateReply(boolean).

See Also:

• Constant Field Values

DEFAULT_EPHEMERAL

public static final ReplyManager.EphemeralType DEFAULT_EPHEMERAL

Default for setEphemeralReply(EphemeralType) (ReplyManager.EphemeralType.NONE).

DEFAULT_INHERIT

public static final boolean DEFAULT_INHERIT

Default for setInheritSettings(boolean).

See Also:

• Constant Field Values

DEFAULT_INVOKE_PARENT

public static final boolean DEFAULT_INVOKE_PARENT

Default for setInvokeParent(boolean).

See Also:

• Constant Field Values

scope

protected Command.Scope scope

The command scope.

callable

protected boolean callable

Whether the command can be invoked directly.

parent

protected Invocation parent

The command parent.

name

protected @MonotonicNonNull @MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name

The command name.

aliases

protected Set<@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String> aliases

The command aliases.

displayName

protected @MonotonicNonNull @MatchesRegex("(?U)^[ -_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String displayName

The display name.

description

protected @MonotonicNonNull @MatchesRegex("(?Us)^.{1,100}+$") String description

The command description.

parameters

protected List<Parameter<?>> parameters

The command parameters.

requiredGroup

protected Group requiredGroup

The group that a user must have access for.

skipGroupCheckOnInteraction

protected boolean skipGroupCheckOnInteraction

Whether group access checking should be skipped.

requireParentGroups

protected boolean requireParentGroups

Whether to also require the parent command's groups.

nsfw

protected boolean nsfw

Whether the command can only be run in NSFW channels.

privateReply

protected boolean privateReply

Whether the command response should only be seen by the caller.

ephemeralReply

protected ReplyManager.EphemeralType ephemeralReply

The type of ephemeral response to use, if any.

inheritSettings

protected boolean inheritSettings

Whether to inherit settings from parent.

invokeParent

protected boolean invokeParent

Whether to execute the parent.

handlers

protected @MonotonicNonNull H extends Handlers handlers

The handlers to process invocations with.

Constructor Details

CommandBuilder

@SideEffectFree
public CommandBuilder()

Constructs a new builder with default values.

CommandBuilder

@SideEffectFree
public CommandBuilder(CommandBuilder<? extends H> base)

Constructs a new builder that is a copy of the given builder.

Parameters:

base - The builder to copy.

Method Details

from

@SideEffectFree
public static <H extends Handlers>
CommandBuilder<H> from(Command<H> base)
                throws IllegalArgumentException

Constructs a new builder that is initialized to make a copy of the given command.

Type Parameters:

H - The handler type.

Parameters:

base - The command to copy.

Returns:

The initialized builder.

Throws:

IllegalArgumentException - if the given command has invalid values.

message

public static CommandBuilder<MessageHandlers> message()

Creates a builder for a message-only command.

Returns:

The builder.

API Note:

Use to force the type argument when it cannot be inferred.

slash

public static CommandBuilder<SlashHandlers> slash()

Creates a builder for a slash-only command.

Returns:

The builder.

API Note:

Use to force the type argument when it cannot be inferred.

text

public static CommandBuilder<TextHandlers> text()

Creates a builder for a text (message and slash) command.

Returns:

The builder.

API Note:

Use to force the type argument when it cannot be inferred.

interaction

public static CommandBuilder<InteractionHandlers> interaction()

Creates a builder for an interaction command.

Returns:

The builder.

API Note:

Use to force the type argument when it cannot be inferred.

withScope

@Deterministic
public CommandBuilder<H> withScope(@Nullable Command.Scope scope)

Sets the command scope.

The default value is DEFAULT_SCOPE.

Parameters:

scope - The command scope. If null, restores the default value.

Returns:

This builder.

See Also:

• Command.scope()

withCallable

@Deterministic
public CommandBuilder<H> withCallable(boolean callable)

Sets whether the command can be invoked directly.

The default value is true.

Parameters:

callable - Whether a user can invoke the command directly.

Returns:

This builder.

See Also:

• Command.callable()

withParent

@Deterministic
public CommandBuilder<H> withParent(@Nullable Invocation parent)

Sets the parent command.

The default value is an empty invocation (no parent).

Parameters:

parent - The invocation of the parent command. If null, restores the default value.

Returns:

This builder.

See Also:

• Command.parent()

withName

@Deterministic
public CommandBuilder<H> withName(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)

Sets the name of the command.

The default value is null, e.g. no value. It must be specified before calling build() (so this method must be called at least once).

Parameters:

name - The command name.

Returns:

This builder.

See Also:

• Command.name()

withAliases

@Deterministic
public CommandBuilder<H> withAliases(@Nullable Set<@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String> aliases)
                              throws IllegalArgumentException

Sets the aliases that a user should support.

The default value is an empty set (no aliases).

Parameters:

aliases - The command aliases. If null, restores the default value.

Returns:

This builder.

Throws:

IllegalArgumentException - if one of the aliases is not valid.

See Also:

• Command.aliases()

addAliases

@Deterministic
public CommandBuilder<H> addAliases(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String... aliases)
                             throws IllegalArgumentException

Adds aliases to the command.

Parameters:

aliases - The aliases to add.

Returns:

This builder.

Throws:

IllegalArgumentException - if any of the aliases is not valid. None will be added.

See Also:

• Command.aliases()

noAliases

@Deterministic
public CommandBuilder<H> noAliases()

Removes all aliases from the command.

Returns:

This builder.

See Also:

• Command.aliases()

withDisplayName

@Deterministic
public CommandBuilder<H> withDisplayName(@MatchesRegex("(?U)^[ -_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)

Sets the display name of the command.

The default value is null, e.g. no value. It must be specified before calling build() (so this method must be called at least once).

Parameters:

name - The command display name.

Returns:

This builder.

See Also:

• Command.displayName()

withDescription

@Deterministic
public CommandBuilder<H> withDescription(@MatchesRegex("(?Us)^.{1,100}+$") String description)

Sets the description of the command.

The default value is null, e.g. no value. It must be specified before calling build() (so this method must be called at least once).

Parameters:

description - The command description.

Returns:

This builder.

See Also:

• Command.description()

withParameters

@Deterministic
public CommandBuilder<H> withParameters(@Nullable List<Parameter<?>> parameters)

Sets the parameters that a user should provide.

The default value is an empty list (no parameters).

Parameters:

parameters - The command parameters. If null, restores the default value.

Returns:

This builder.

See Also:

• Command.parameters()

addParameter

@Deterministic
public CommandBuilder<H> addParameter(Parameter<?> parameter)

Adds a parameter to the command.

Parameters:

parameter - The parameter to add.

Returns:

This builder.

See Also:

• Command.parameters()

noParameters

@Deterministic
public CommandBuilder<H> noParameters()

Removes all parameters from the command.

Returns:

This builder.

See Also:

• Command.parameters()

requireGroup

@Deterministic
public CommandBuilder<H> requireGroup(@Nullable Group group)

Sets the group that a user must have access for.

The default value is DEFAULT_GROUP.

Parameters:

group - The required group. If null, restores the default value.

Returns:

This builder.

See Also:

• Command.requiredGroup()

setSkipGroupCheckOnInteraction

@Deterministic
public CommandBuilder<H> setSkipGroupCheckOnInteraction(boolean skip)

Sets whether group access checking should be skipped.

The default value is true, as application commands should generally avoid clashing with user-set permissions unless necessary.

Parameters:

skip - Whether group access checking should be skipped.

Returns:

This builder.

See Also:

• Command.skipGroupCheckOnInteraction()

setRequireParentGroups

@Deterministic
public CommandBuilder<H> setRequireParentGroups(boolean require)

Sets whether the command also require its parent command's groups.

The default value is true.

Parameters:

require - Whether to require the parent's groups.

Returns:

This builder.

See Also:

• Command.requireParentGroups()

setNsfw

@Deterministic
public CommandBuilder<H> setNsfw(boolean nsfw)

Sets whether the command can only be run in channels marked as NSFW.

The default value is false.

Parameters:

nsfw - Whether the command is NSFW.

Returns:

This builder.

See Also:

• Command.nsfw()

setPrivateReply

@Deterministic
public CommandBuilder<H> setPrivateReply(boolean privateReply)

Sets whether the command response should be sent privately to the caller.

The default value is false.

Parameters:

privateReply - Whether the response should be sent privately.

Returns:

This builder.

See Also:

• Command.privateReply()

setEphemeralReply

@Deterministic
public CommandBuilder<H> setEphemeralReply(@Nullable ReplyManager.EphemeralType ephemeralReply)

Sets the type of ephemeral response to use, if any.

The default value is DEFAULT_EPHEMERAL.

Parameters:

ephemeralReply - The type of ephemeral response to use, if any. If null, restores the default value.

Returns:

This builder.

See Also:

• Command.ephemeralReply()

setInheritSettings

@Deterministic
public CommandBuilder<H> setInheritSettings(boolean inheritSettings)

Sets whether the command should inherit settings from the parent command.

The default value is false.

Parameters:

inheritSettings - Whether the command inherits the parent command's settings.

Returns:

This builder.

See Also:

• Command.inheritSettings()

setInvokeParent

@Deterministic
public CommandBuilder<H> setInvokeParent(boolean invokeParent)

Sets whether the command should also invoke the parent's handler.

The default value is false.

Parameters:

invokeParent - Whether the command should invoke the parent's handler.

Returns:

This builder.

See Also:

• Command.invokeParent()

withHandlers

@Deterministic
public CommandBuilder<H> withHandlers(H handlers)

Sets the handlers of the command.

The default value is null, e.g. no value. It must be specified before calling build() (so this method must be called at least once).

Parameters:

handlers - The handlers.

Returns:

This builder.

See Also:

• Command.handlers()

build

@SideEffectFree
public Command<H> build(CommandBuilder<H extends Handlers> this)
                 throws IllegalStateException

Builds the configured command.

Returns:

The built command.

Throws:

IllegalStateException - if the current configuration is invalid.