Package net.okocraft.box.api.command

Class SubCommandHoldable.SubCommandHolder

java.lang.Object

net.okocraft.box.api.command.SubCommandHoldable.SubCommandHolder

Enclosing interface:

SubCommandHoldable

public static class SubCommandHoldable.SubCommandHolder
extends Object

A class that holds subcommands.

Constructor Summary

Constructors

Constructor	Description
SubCommandHolder(@NotNull Command... subCommands)	The constructor of SubCommandHoldable.SubCommandHolder.

Method Summary

Modifier and Type	Method	Description
@NotNull @Unmodifiable List<Command>	getSubCommands()	Gets the set of subcommands.
void	register(@NotNull Command subCommand)	Registers the new subcommand.
@NotNull Optional<Command>	search(@NotNull String name)	Searches for a command that matches the name or aliases.
void	unregister(@NotNull Command subCommand)	Unregisters the subcommand.

Methods inherited from class java.lang.Object

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

Constructor Details

SubCommandHolder

public SubCommandHolder(@NotNull
 @NotNull Command... subCommands)

The constructor of SubCommandHoldable.SubCommandHolder.

Parameters:

subCommands - the set of subcommands

Method Details

getSubCommands

@NotNull
public @NotNull @Unmodifiable List<Command> getSubCommands()

Gets the set of subcommands.

The returned list can be changed in implementation, but it should not add or remove.

Returns:

the list of subcommands

register

public void register(@NotNull
 @NotNull Command subCommand)

Registers the new subcommand.

Parameters:

subCommand - the new subcommand

unregister

public void unregister(@NotNull
 @NotNull Command subCommand)

Unregisters the subcommand.

Parameters:

subCommand - the subcommand to unregister

search

@NotNull
public @NotNull Optional<Command> search(@NotNull
 @NotNull String name)

Searches for a command that matches the name or aliases.

Parameters:

name - the name or the alias of the command

Returns:

the search result