Package org.incendo.cloud.caption

Class CaptionRegistryImpl<C>

java.lang.Object

org.incendo.cloud.caption.CaptionRegistryImpl<C>

All Implemented Interfaces:

CaptionRegistry<C>

@API(status=INTERNAL)
public final class CaptionRegistryImpl<C>
extends Object
implements CaptionRegistry<C>

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.
@NonNull CaptionRegistry<C>	registerProvider(@NonNull CaptionProvider<C> provider)	Registers the given provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

caption

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

Description copied from interface: CaptionRegistry

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

Specified by:

caption in interface CaptionRegistry<C>

Parameters:

caption - the caption key

sender - the sender to get the caption for

Returns:

the caption value

registerProvider

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

Description copied from interface: CaptionRegistry

Registers the given provider.

When CaptionRegistry.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.

Specified by:

registerProvider in interface CaptionRegistry<C>

Parameters:

provider - the provider

Returns:

this