Package org.incendo.cloud.caption

Class CaptionFormatter.PatternReplacingCaptionFormatter<C>

java.lang.Object

org.incendo.cloud.caption.CaptionFormatter.PatternReplacingCaptionFormatter<C>

All Implemented Interfaces:

CaptionFormatter<C,String>

Enclosing interface:

CaptionFormatter<C,T>

public static final class CaptionFormatter.PatternReplacingCaptionFormatter<C>
extends Object
implements CaptionFormatter<C,String>

Nested Class Summary

Nested classes/interfaces inherited from interface org.incendo.cloud.caption.CaptionFormatter

CaptionFormatter.PatternReplacingCaptionFormatter<C>

Method Summary

Modifier and Type	Method	Description
@NonNull String	formatCaption(@NonNull Caption captionKey, @NonNull C recipient, @NonNull String caption, @NonNull List<@NonNull CaptionVariable> variables)	Formats the caption.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.incendo.cloud.caption.CaptionFormatter

formatCaption

Method Details

formatCaption

public @NonNull String formatCaption(@NonNull Caption captionKey,
 @NonNull C recipient,
 @NonNull String caption,
 @NonNull List<@NonNull CaptionVariable> variables)

Description copied from interface: CaptionFormatter

Formats the caption.

Specified by:

formatCaption in interface CaptionFormatter<C,String>

Parameters:

captionKey - the caption key

recipient - the recipient of the message

caption - the value of the caption

variables - the caption variables

Returns:

the transformed message