Package cloud.commandframework.captions

Class Caption

java.lang.Object

cloud.commandframework.captions.Caption

public final class Caption
extends Object

This is a reference to a caption and does not contain any message itself

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NonNull String	getKey()	Get the caption key
int	hashCode()
static @NonNull Caption	of(@NonNull String key)	Create a new caption with a given key
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

of

public static @NonNull Caption of(@NonNull String key)

Create a new caption with a given key

Parameters:

key - Caption key

Returns:

Created caption

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getKey

public @NonNull String getKey()

Get the caption key

Returns:

Caption key

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object