Package cloud.commandframework.captions

Class CaptionVariable

java.lang.Object

cloud.commandframework.captions.CaptionVariable

@API(status=STABLE)
public final class CaptionVariable
extends Object

Key-value pair used to replace variables in captions

Method Summary

Modifier and Type	Method	Description
@NonNull String	getKey()	Get the variable key
@NonNull String	getValue()	Get the variable value
static @NonNull CaptionVariable	of(@NonNull String key, @NonNull String value)	Create a new caption variable instance

Methods inherited from class java.lang.Object

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

Method Details

of

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

Create a new caption variable instance

Parameters:

key - Key

value - Replacement

Returns:

Created instance

getKey

public @NonNull String getKey()

Get the variable key

Returns:

Key

getValue

public @NonNull String getValue()

Get the variable value

Returns:

Value