Package org.incendo.cloud.caption

Interface CaptionRegistry<C>

Type Parameters:

C - command sender type

All Known Implementing Classes:

CaptionRegistryImpl

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

Registry that allows for messages to be configurable per-sender. Delegates to registered CaptionProviders.

Method Summary

Modifier and Type	Method	Description
@NonNull String	caption(@NonNull Caption caption, @NonNull C sender)	Returns the value of the given caption for the given sender.
static <C> CaptionRegistry<C>	captionRegistry()	Creates a new caption registry with no providers registered.
@NonNull CaptionRegistry<C>	registerProvider(@NonNull CaptionProvider<C> provider)	Registers the given provider.

Method Details

caption

@NonNull String caption(@NonNull Caption caption,
 @NonNull C sender)

Returns the value of the given caption for the given sender.

Parameters:

caption - the caption key

sender - the sender to get the caption for

Returns:

the caption value

registerProvider

@NonNull CaptionRegistry<C> registerProvider(@NonNull CaptionProvider<C> provider)

Registers the given provider.

When caption(Caption, Object) is invoked, all providers will be iterated over (with the last registered provider getting priority) until a provider returns a non-null value for the caption.

You may use CaptionProvider.forCaption(Caption, Function) to register per-caption providers, or CaptionProvider.constantProvider(Caption, String) to register constant values.

Parameters:

provider - the provider

Returns:

this

captionRegistry

static <C> CaptionRegistry<C> captionRegistry()

Creates a new caption registry with no providers registered.

Type Parameters:

C - command sender type

Returns:

new caption registry