Package org.incendo.cloud.annotations

Interface BuilderDecorator<C>

Type Parameters:

C - the command sender type

@API(status=STABLE)
public interface BuilderDecorator<C>

Decorators that get to modify a command builder that is used to construct the command for annotated command methods.

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull BuilderDecorator<C>	applicable(@NonNull Command.Builder.Applicable<C> applicable)	Returns a BuilderDecorator applies the given applicable to the command builders.
@NonNull Command.Builder<C>	decorate(@NonNull Command.Builder<C> builder)	Decorates the given builder and returns the result.
static <C> @NonNull BuilderDecorator<C>	defaultDescription(@NonNull CommandDescription description)	Returns a BuilderDecorator that sets the default description of a command.
static <C> @NonNull BuilderDecorator<C>	defaultPermission(@NonNull Permission permission)	Returns a BuilderDecorator that sets the default permission of a command.

Method Details

defaultDescription

static <C> @NonNull BuilderDecorator<C> defaultDescription(@NonNull CommandDescription description)

Returns a BuilderDecorator that sets the default description of a command.

Type Parameters:

C - the command sender type

Parameters:

description - the description

Returns:

the decorator

defaultPermission

static <C> @NonNull BuilderDecorator<C> defaultPermission(@NonNull Permission permission)

Returns a BuilderDecorator that sets the default permission of a command.

Type Parameters:

C - the command sender type

Parameters:

permission - the permission

Returns:

the decorator

applicable

static <C> @NonNull BuilderDecorator<C> applicable(@NonNull Command.Builder.Applicable<C> applicable)

Returns a BuilderDecorator applies the given applicable to the command builders.

Type Parameters:

C - the command sender type

Parameters:

applicable - the applicable to apply

Returns:

the decorator

decorate

@NonNull Command.Builder<C> decorate(@NonNull Command.Builder<C> builder)

Decorates the given builder and returns the result.

Parameters:

builder - the builder to decorate

Returns:

the result