me.vaperion.blade.sender

Interface SenderProvider<T>

Type Parameters:

T - the type

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SenderProvider<T>

A provider that converts the given Sender into a specific type.

Method Summary

Modifier and Type	Method and Description
default @Nullable java.lang.String	friendlyName(boolean plural) Provides a friendly name for this sender type, used in error messages.
T	provide(@NotNull Context context, @NotNull Sender<?> sender) Converts the given Sender into the specific type.

Method Detail

provide

@Nullable
T provide(@NotNull
                    @NotNull Context context,
                    @NotNull
                    @NotNull Sender<?> sender)
             throws BladeParseError

Converts the given Sender into the specific type.

Parameters:

context - the command context

sender - the sender

Returns:

the converted value, or null if conversion failed

Throws:

BladeParseError - if an error occurs during conversion (use BladeParseError.fatal(String) or BladeParseError.recoverable(String).)

friendlyName

@Nullable
default @Nullable java.lang.String friendlyName(boolean plural)

Provides a friendly name for this sender type, used in error messages.

Parameters:

plural - whether the name should be plural

Returns:

the friendly name, or null to use a default name