me.vaperion.blade.context

Interface Sender<T>

public interface Sender<T>

Method Summary

Modifier and Type	Method and Description
boolean	hasPermission(@NotNull java.lang.String permission) Check if this sender has a specific permission.
boolean	isExpectedType(@NotNull BladeCommand command) Check if this wrapped sender is of the expected type for the given command.
@NotNull java.lang.String	name() Get the name of this sender.
<S> S	parseAs(@NotNull java.lang.Class<S> clazz) Attempt to "parse" (or convert) the underlying platform-specific sender type to the given class type.
T	rawSender() Get the raw platform instance of this wrapped sender.
@NotNull java.lang.Object	underlyingSender() Get the underlying platform-specific sender object.
@NotNull java.lang.Class<?>	underlyingSenderType() Get the class type of the underlying sender.

Method Detail

rawSender

@NotNull
T rawSender()

Get the raw platform instance of this wrapped sender.

This is the actual platform-specific sender type, such as a Player, CommandSource, etc.

Returns:

the platform sender instance

underlyingSender

@ApiStatus.Internal
 @NotNull
@NotNull java.lang.Object underlyingSender()

Get the underlying platform-specific sender object.

On most platforms, this will be the same as getSender(), but some platforms may use proxies or dynamic types. (e.g. Fabric's CommandSource)

Returns:

the underlying platform-specific sender object

underlyingSenderType

@ApiStatus.Internal
 @NotNull
@NotNull java.lang.Class<?> underlyingSenderType()

Get the class type of the underlying sender.

On most platforms, this will be the same as getSender().getClass(), but some platforms may use proxies or dynamic types. (e.g. Fabric's CommandSource)

Returns:

the class type of the underlying sender

name

@NotNull
@NotNull java.lang.String name()

Get the name of this sender.

Returns:

the name of the sender

hasPermission

boolean hasPermission(@NotNull
                      @NotNull java.lang.String permission)

Check if this sender has a specific permission.

Parameters:

permission - the permission to check

Returns:

true if the sender has the permission, false otherwise

parseAs

@Nullable
<S> S parseAs(@NotNull
                        @NotNull java.lang.Class<S> clazz)

Attempt to "parse" (or convert) the underlying platform-specific sender type to the given class type.

If the conversion is not possible, this method will return null.

Parameters:

clazz - the class to parse the sender as

Returns:

the parsed sender if successful, null otherwise

isExpectedType

@ApiStatus.Internal
boolean isExpectedType(@NotNull
                                           @NotNull BladeCommand command)

Check if this wrapped sender is of the expected type for the given command.

Parameters:

command - the command to check against

Returns:

true if the sender is of the expected type, false otherwise