Package org.incendo.cloud.caption

Class ConstantCaptionProvider<C>

java.lang.Object

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

All Implemented Interfaces:

CaptionProvider<C>

Direct Known Subclasses:

ImmutableConstantCaptionProvider

@Immutable
@API(status=STABLE)
public abstract class ConstantCaptionProvider<C>
extends Object
implements CaptionProvider<C>

Constructor Summary

Constructors

Constructor	Description
ConstantCaptionProvider()

Method Summary

Modifier and Type	Method	Description
abstract @NonNull Map<@NonNull Caption,@NonNull String>	captions()	Returns all recognized captions and their corresponding constant values.
final @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.

Methods inherited from class java.lang.Object

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

Constructor Details

ConstantCaptionProvider

public ConstantCaptionProvider()

Method Details

captions

public abstract @NonNull Map<@NonNull Caption,@NonNull String> captions()

Returns all recognized captions and their corresponding constant values.

Returns:

the captions

provide

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

Description copied from interface: CaptionProvider

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

Specified by:

provide in interface CaptionProvider<C>

Parameters:

caption - the caption key

recipient - the recipient

Returns:

the caption, or null