org.spongepowered.api.text

Class TranslatableText

java.lang.Object

org.spongepowered.api.text.Text

org.spongepowered.api.text.TranslatableText

All Implemented Interfaces:

Comparable<Text>, DataSerializable, TextElement, TextRepresentable

public final class TranslatableText
extends Text

Represents a Text containing a Translation identifier that gets translated into the current locale on the client.

See Also:

TranslatableText.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TranslatableText.Builder Represents a Text.Builder creating immutable TranslatableText instances.

Field Summary

Fields inherited from class org.spongepowered.api.text.Text

EMPTY, NEW_LINE, PLAIN_COMPARATOR

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ImmutableList<Object>	getArguments() Returns the list of Translation arguments used to format this Text.
Translation	getTranslation() Returns the translation of this Text.
int	hashCode()
TranslatableText.Builder	toBuilder() Returns a new Text.Builder with the content, formatting and actions of this text.

Methods inherited from class org.spongepowered.api.text.Text

builder, builder, builder, builder, builder, builder, builder, builder, builder, builder, builder, builder, compareTo, concat, getChildren, getClickAction, getColor, getContentVersion, getFormat, getHoverAction, getShiftClickAction, getStyle, isEmpty, join, join, join, joinWith, joinWith, joinWith, of, of, of, of, of, of, of, of, replace, replace, replace, replace, toContainer, toPlain, toPlainSingle, toString, toText, trim, withChildren

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.text.TextRepresentable

applyTo

Method Detail

getTranslation

public Translation getTranslation()

Returns the translation of this Text.

Returns:

The translation of this text

getArguments

public ImmutableList<Object> getArguments()

Returns the list of Translation arguments used to format this Text.

Returns:

The list of translation arguments

toBuilder

public TranslatableText.Builder toBuilder()

Description copied from class: Text

Returns a new Text.Builder with the content, formatting and actions of this text. This can be used to edit an otherwise immutable Text instance.

Specified by:

toBuilder in class Text

Returns:

A new message builder with the content of this text

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Text

hashCode

public int hashCode()

Overrides:

hashCode in class Text