Package org.incendo.cloud.brigadier

Interface BrigadierManagerHolder<C,S>

Type Parameters:

C - cloud command sender type

S - brigadier command source type

@API(status=STABLE,
     since="2.0.0")
public interface BrigadierManagerHolder<C,S>

Interface implemented by command managers that are capable of registering commands to Brigadier using CloudBrigadierManager.

Since:

1.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BrigadierManagerHolder.BrigadierManagerNotPresent	Exception thrown when brigadierManager() is called and hasBrigadierManager() is false.

Method Summary

Modifier and Type	Method	Description
@NonNull CloudBrigadierManager<C,? extends S>	brigadierManager()	Get the CloudBrigadierManager used by this command manager.
boolean	hasBrigadierManager()	Returns whether the CloudBrigadierManager is present and active.

Method Details

hasBrigadierManager

@API(status=STABLE,
     since="2.0.0")
boolean hasBrigadierManager()

Returns whether the CloudBrigadierManager is present and active.

Returns:

if the brigadier manager is present and active

Since:

2.0.0

brigadierManager

@API(status=STABLE,
     since="2.0.0")
@NonNull CloudBrigadierManager<C,? extends S> brigadierManager()

Get the CloudBrigadierManager used by this command manager.

Generally, hasBrigadierManager() should be checked before calling this method. However, some command managers will always use Brigadier and in those cases the check can be skipped (this will be in the relevant manager's documentation).

Returns:

the CloudBrigadierManager

Throws:

BrigadierManagerHolder.BrigadierManagerNotPresent - when hasBrigadierManager() is false

Since:

1.2.0