org.spongepowered.api.text.format

Class TextFormat

java.lang.Object

org.spongepowered.api.text.format.TextFormat

All Implemented Interfaces:

TextElement

public final class TextFormat
extends Object
implements TextElement

Represents a pair of TextStyle and TextColor.

Field Summary

Fields

Modifier and Type	Field and Description
static TextFormat	NONE An empty TextFormat with no TextColor and no TextStyle.

Method Summary

Modifier and Type	Method and Description
void	applyTo(Text.Builder builder) Applies this element to the end of the specified builder.
TextFormat	color(TextColor color) Returns a new TextFormat with the given color.
boolean	equals(Object o)
TextColor	getColor() Returns the TextColor in this format.
TextStyle	getStyle() Returns the TextStyle in this format.
int	hashCode()
boolean	isEmpty() Returns whether this TextFormat has no color and format specified.
TextFormat	merge(TextFormat format) Returns a new TextFormat that combines this and the given format.
static TextFormat	of() Gets the TextFormat with the default style and color.
static TextFormat	of(TextColor color) Constructs a new TextFormat with the specific color.
static TextFormat	of(TextColor color, TextStyle style) Constructs a new TextFormat with the specific color and style.
static TextFormat	of(TextStyle style) Constructs a new TextFormat with the specific style.
TextFormat	style(TextStyle style) Returns a new TextFormat with the given style.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final TextFormat NONE

An empty TextFormat with no TextColor and no TextStyle.

Method Detail

of

public static TextFormat of()

Gets the TextFormat with the default style and color.

Returns:

The empty text format

of

public static TextFormat of(TextStyle style)

Constructs a new TextFormat with the specific style.

Parameters:

style - The style

Returns:

The new text format

of

public static TextFormat of(TextColor color)

Constructs a new TextFormat with the specific color.

Parameters:

color - The color

Returns:

The new text format

of

public static TextFormat of(TextColor color,
                            TextStyle style)

Constructs a new TextFormat with the specific color and style.

Parameters:

color - The color

style - The style

Returns:

The new text format

getColor

public TextColor getColor()

Returns the TextColor in this format.

Returns:

The color

getStyle

public TextStyle getStyle()

Returns the TextStyle in this format.

Returns:

The style

color

public TextFormat color(TextColor color)

Returns a new TextFormat with the given color.

Parameters:

color - The color

Returns:

The new text format

style

public TextFormat style(TextStyle style)

Returns a new TextFormat with the given style.

Parameters:

style - The style

Returns:

The new text format

merge

public TextFormat merge(TextFormat format)

Returns a new TextFormat that combines this and the given format. The given format takes higher priority than this one. Due to this the color will only fallback to this one if the given format's color is TextColors.NONE. If the given format's color is TextColors.RESET then TextColors.NONE will be used. Styles are combined using TextStyle.and(TextStyle...).

Parameters:

format - The format to merge

Returns:

The new text format

isEmpty

public boolean isEmpty()

Returns whether this TextFormat has no color and format specified.

Returns:

If the format does not contain a color or any styles

applyTo

public void applyTo(Text.Builder builder)

Description copied from interface: TextElement

Applies this element to the end of the specified builder.

Specified by:

applyTo in interface TextElement

Parameters:

builder - Text builder to apply to

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object