net.kyori.text.format

Class Style

java.lang.Object

net.kyori.text.format.Style

public final class Style
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Style.Builder A style builder.

Method Summary

Modifier and Type	Method and Description
static @NonNull Style.Builder	builder() Creates a builder.
@Nullable ClickEvent	clickEvent() Gets the click event.
@NonNull Style	clickEvent(@Nullable ClickEvent event) Sets the click event.
@Nullable TextColor	color() Gets the color.
@NonNull Style	color(@Nullable TextColor color) Sets the color.
@NonNull Style	colorIfAbsent(@Nullable TextColor color) Sets the color if there isn't one set already.
TextDecoration.State	decoration(@NonNull TextDecoration decoration) Gets the state of a decoration on this style.
@NonNull Style	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this style.
@NonNull Style	decoration(@NonNull TextDecoration decoration, TextDecoration.State state) Sets the value of a decoration on this style.
@NonNull java.util.Set<TextDecoration>	decorations() Gets a set of decorations this style has.
@NonNull java.util.Set<TextDecoration>	decorations(@NonNull java.util.Set<TextDecoration> defaultValues) Gets a set of decorations this style has.
static @NonNull Style	empty() Gets an empty style.
boolean	equals(@Nullable java.lang.Object other)
boolean	hasDecoration(@NonNull TextDecoration decoration) Tests if this style has a decoration.
int	hashCode()
@Nullable HoverEvent	hoverEvent() Gets the hover event.
@NonNull Style	hoverEvent(@Nullable HoverEvent event) Sets the hover event.
@Nullable java.lang.String	insertion() Gets the string to be inserted when this style is shift-clicked.
@NonNull Style	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted when this style is shift-clicked.
boolean	isEmpty() Tests if this style is empty.
@NonNull Style	mergeColor(@NonNull Style that) Merges the color from another style into this style.
@NonNull Style	mergeDecorations(@NonNull Style that) Merges the decorations from another style into this style.
@NonNull Style	mergeEvents(@NonNull Style that) Merges the events from another style into this style.
static @NonNull Style	of(@Nullable TextColor color) Creates a style with color.
static @NonNull Style	of(@Nullable TextColor color, TextDecoration... decorations) Creates a style with color and decorations.
@NonNull Style.Builder	toBuilder() Create a builder from this style.
@NonNull java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static @NonNull Style.Builder builder()

Creates a builder.

Returns:

a builder

empty

public static @NonNull Style empty()

Gets an empty style.

Returns:

empty style

of

public static @NonNull Style of(@Nullable TextColor color)

Creates a style with color.

Parameters:

color - the style

Returns:

a style

of

public static @NonNull Style of(@Nullable TextColor color,
                                TextDecoration... decorations)

Creates a style with color and decorations.

Parameters:

color - the style

decorations - the decorations

Returns:

a style

color

public @Nullable TextColor color()

Gets the color.

Returns:

the color

colorIfAbsent

public @NonNull Style colorIfAbsent(@Nullable TextColor color)

Sets the color if there isn't one set already.

Parameters:

color - the color

Returns:

this builder

color

public @NonNull Style color(@Nullable TextColor color)

Sets the color.

Parameters:

color - the color

Returns:

a style

hasDecoration

public boolean hasDecoration(@NonNull TextDecoration decoration)

Tests if this style has a decoration.

Parameters:

decoration - the decoration

Returns:

true if this style has the decoration, false if this style does not have the decoration

decoration

public TextDecoration.State decoration(@NonNull TextDecoration decoration)

Gets the state of a decoration on this style.

Parameters:

decoration - the decoration

Returns:

TextDecoration.State.TRUE if this style has the decoration, TextDecoration.State.FALSE if this style does not have the decoration, and TextDecoration.State.NOT_SET if not set

decoration

public @NonNull Style decoration(@NonNull TextDecoration decoration,
                                 boolean flag)

Sets the state of a decoration on this style.

Parameters:

decoration - the decoration

flag - true if this style should have the decoration, false if this style should not have the decoration

Returns:

a style

decoration

public @NonNull Style decoration(@NonNull TextDecoration decoration,
                                 TextDecoration.State state)

Sets the value of a decoration on this style.

Parameters:

decoration - the decoration

state - TextDecoration.State.TRUE if this style should have the decoration, TextDecoration.State.FALSE if this style should not have the decoration, and TextDecoration.State.NOT_SET if the decoration should not have a set value

Returns:

a style

decorations

public @NonNull java.util.Set<TextDecoration> decorations()

Gets a set of decorations this style has.

Returns:

a set of decorations this style has

decorations

public @NonNull java.util.Set<TextDecoration> decorations(@NonNull java.util.Set<TextDecoration> defaultValues)

Gets a set of decorations this style has.

Parameters:

defaultValues - a set of default values

Returns:

a set of decorations this style has

clickEvent

public @Nullable ClickEvent clickEvent()

Gets the click event.

Returns:

the click event

clickEvent

public @NonNull Style clickEvent(@Nullable ClickEvent event)

Sets the click event.

Parameters:

event - the click event

Returns:

a style

hoverEvent

public @Nullable HoverEvent hoverEvent()

Gets the hover event.

Returns:

the hover event

hoverEvent

public @NonNull Style hoverEvent(@Nullable HoverEvent event)

Sets the hover event.

Parameters:

event - the hover event

Returns:

a style

insertion

public @Nullable java.lang.String insertion()

Gets the string to be inserted when this style is shift-clicked.

Returns:

the insertion string

insertion

public @NonNull Style insertion(@Nullable java.lang.String insertion)

Sets the string to be inserted when this style is shift-clicked.

Parameters:

insertion - the insertion string

Returns:

a style

mergeColor

public @NonNull Style mergeColor(@NonNull Style that)

Merges the color from another style into this style.

Parameters:

that - the other style

Returns:

a style

mergeDecorations

public @NonNull Style mergeDecorations(@NonNull Style that)

Merges the decorations from another style into this style.

Parameters:

that - the other style

Returns:

a style

mergeEvents

public @NonNull Style mergeEvents(@NonNull Style that)

Merges the events from another style into this style.

Parameters:

that - the other style

Returns:

a style

isEmpty

public boolean isEmpty()

Tests if this style is empty.

Returns:

true if this style is empty, false if this style is not empty

toBuilder

public @NonNull Style.Builder toBuilder()

Create a builder from this style.

Returns:

a builder

toString

public @NonNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(@Nullable java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object