Package org.incendo.cloud.minecraft.extras

Class RichDescription

java.lang.Object

org.incendo.cloud.minecraft.extras.RichDescription

All Implemented Interfaces:

Description

public final class RichDescription
extends Object
implements Description

A description implementation that uses Adventure components.

Since:

1.4.0

Method Summary

Modifier and Type	Method	Description
@NonNull Component	contents()	Returns the contents of this description.
static @NonNull RichDescription	empty()	Get an empty description.
boolean	equals(Object object)
int	hashCode()
boolean	isEmpty()
static @NonNull RichDescription	of(@NonNull ComponentLike contents)	Create a new rich description from the provided component.
static @NonNull RichDescription	richDescription(@NonNull ComponentLike contents)	Create a new rich description from the provided component.
@NonNull String	textDescription()	Deprecated. to discourage use.
static @NonNull RichDescription	translatable(@NonNull String key)	Create a rich description pointing to a translation key.
static @NonNull RichDescription	translatable(@NonNull String key, @NonNull ComponentLike @NonNull ... args)	Create a rich description pointing to a translation key.

Methods inherited from class java.lang.Object

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

Method Details

empty

public static @NonNull RichDescription empty()

Get an empty description.

Returns:

the empty description

of

public static @NonNull RichDescription of(@NonNull ComponentLike contents)

Create a new rich description from the provided component.

Parameters:

contents - the rich contents

Returns:

a new rich description

richDescription

public static @NonNull RichDescription richDescription(@NonNull ComponentLike contents)

Create a new rich description from the provided component. Alias for of(ComponentLike).

Parameters:

contents - the rich contents

Returns:

a new rich description

translatable

public static @NonNull RichDescription translatable(@NonNull String key)

Create a rich description pointing to a translation key.

Parameters:

key - the translation key

Returns:

a new rich description

translatable

public static @NonNull RichDescription translatable(@NonNull String key,
 @NonNull ComponentLike @NonNull ... args)

Create a rich description pointing to a translation key.

Parameters:

key - the translation key

args - the arguments to use with the translation key

Returns:

a new rich description

textDescription

@Deprecated
public @NonNull String textDescription()

Deprecated.

to discourage use. A plain serialization is a somewhat expensive and lossy operation, use contents() instead.

Specified by:

textDescription in interface Description

contents

@API(status=STABLE,
     since="2.0.0")
public @NonNull Component contents()

Returns the contents of this description.

Returns:

the component contents of this description

Since:

2.0.0

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Description

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object