Package org.incendo.cloud.caption

Interface CaptionProvider<C>

All Known Implementing Classes:

ConstantCaptionProvider, DelegatingCaptionProvider, ImmutableConstantCaptionProvider, StandardCaptionsProvider

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

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull ImmutableConstantCaptionProvider.Builder<C>	constantProvider()	Returns a builder for a ConstantCaptionProvider.
static <C> @NonNull CaptionProvider<C>	constantProvider(@NonNull Caption caption, @NonNull String value)	Returns a ConstantCaptionProvider that always returns value for the given caption.
static <C> @NonNull CaptionProvider<C>	forCaption(@NonNull Caption caption, @NonNull Function<@NonNull C,@Nullable String> provider)	Returns a CaptionProvider that only returns values for the given caption, and returns null for all other captions.
@Nullable String	provide(@NonNull Caption caption, @NonNull C recipient)	Returns the value of the given caption for the given recipient, if it recognized by this provider.

Method Details

constantProvider

static <C>
@NonNull ImmutableConstantCaptionProvider.Builder<C> constantProvider()

Returns a builder for a ConstantCaptionProvider.

Type Parameters:

C - the command sender type

Returns:

the builder

constantProvider

static <C> @NonNull CaptionProvider<C> constantProvider(@NonNull Caption caption,
 @NonNull String value)

Returns a ConstantCaptionProvider that always returns value for the given caption.

Type Parameters:

C - the command sender type

Parameters:

caption - the caption key

value - the value

Returns:

the provider

forCaption

static <C> @NonNull CaptionProvider<C> forCaption(@NonNull Caption caption,
 @NonNull Function<@NonNull C,@Nullable String> provider)

Returns a CaptionProvider that only returns values for the given caption, and returns null for all other captions.

Type Parameters:

C - the command sender type

Parameters:

caption - the caption key

provider - the provider of the value

Returns:

the provider

provide

@Nullable String provide(@NonNull Caption caption,
 @NonNull C recipient)

Returns the value of the given caption for the given recipient, if it recognized by this provider.

Parameters:

caption - the caption key

recipient - the recipient

Returns:

the caption, or null