Package org.incendo.cloud.caption

Interface CaptionVariable

@Immutable
@API(status=STABLE)
public interface CaptionVariable

Key-value pair used to replace variables in captions.

Method Summary

Modifier and Type	Method	Description
@NonNull String	key()	Returns the variable key.
static @NonNull CaptionVariable	of(@NonNull String key, @NonNull String value)	Creates a new caption variable instance.
@NonNull String	value()	Returns the variable value

Method Details

of

static @NonNull CaptionVariable of(@NonNull String key,
 @NonNull String value)

Creates a new caption variable instance.

Parameters:

key - the key

value - the value that replaces the placeholder

Returns:

the variable instance

key

@NonNull String key()

Returns the variable key.

Returns:

the key

value

@NonNull String value()

Returns the variable value

Returns:

the value