net.kyori.text

Class ScoreComponent

java.lang.Object

net.kyori.text.AbstractComponent

net.kyori.text.AbstractBuildableComponent<ScoreComponent,ScoreComponent.Builder>

net.kyori.text.ScoreComponent

All Implemented Interfaces:

BuildableComponent<ScoreComponent,ScoreComponent.Builder>, Component

public class ScoreComponent
extends AbstractBuildableComponent<ScoreComponent,ScoreComponent.Builder>

A scoreboard score component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScoreComponent.Builder A score component builder.

Nested classes/interfaces inherited from class net.kyori.text.AbstractBuildableComponent

AbstractBuildableComponent.AbstractBuilder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>

Field Summary

Fields inherited from class net.kyori.text.AbstractComponent

bold, children, clickEvent, color, hoverEvent, insertion, italic, obfuscated, strikethrough, underlined

Fields inherited from interface net.kyori.text.Component

EMPTY_COMPONENT_LIST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScoreComponent(@NonNull java.util.List<Component> children, @Nullable TextColor color, TextDecoration.State obfuscated, TextDecoration.State bold, TextDecoration.State strikethrough, TextDecoration.State underlined, TextDecoration.State italic, @Nullable ClickEvent clickEvent, @Nullable HoverEvent hoverEvent, @Nullable java.lang.String insertion, @NonNull java.lang.String name, @NonNull java.lang.String objective, @Nullable java.lang.String value)
protected	ScoreComponent(@NonNull ScoreComponent.Builder builder)

Method Summary

Modifier and Type	Method and Description
@NonNull ScoreComponent	append(@NonNull Component component) Appends a component to this component.
static ScoreComponent.Builder	builder() Creates a score component builder.
static ScoreComponent.Builder	builder(@NonNull java.lang.String name, @NonNull java.lang.String objective) Creates a score component builder with a name and objective.
@NonNull ScoreComponent	clickEvent(@Nullable ClickEvent event) Sets the click event of this component.
@NonNull ScoreComponent	color(@Nullable TextColor color) Sets the color of this component.
@NonNull ScoreComponent	content(@NonNull java.lang.String value) Sets the value.
@NonNull ScoreComponent	copy() Creates a component.
@NonNull ScoreComponent	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this component.
@NonNull ScoreComponent	decoration(@NonNull TextDecoration decoration, TextDecoration.State state) Sets the value of a decoration on this component.
boolean	equals(@Nullable java.lang.Object other)
int	hashCode()
@NonNull ScoreComponent	hoverEvent(@Nullable HoverEvent event) Sets the hover event of this component.
@NonNull ScoreComponent	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted when this component is shift-clicked.
@NonNull ScoreComponent	mergeColor(@NonNull Component that) Merges the color from another component into this component.
@NonNull ScoreComponent	mergeDecorations(@NonNull Component that) Merges the decorations from another component into this component.
@NonNull ScoreComponent	mergeEvents(@NonNull Component that) Merges the events from another component into this component.
@NonNull ScoreComponent	mergeStyle(@NonNull Component that) Merges styling from another component into this component.
@NonNull java.lang.String	name() Gets the score name.
@NonNull ScoreComponent	name(@NonNull java.lang.String name) Sets the score name.
@NonNull java.lang.String	objective() Gets the objective name.
@NonNull ScoreComponent	objective(@NonNull java.lang.String objective) Sets the score objective.
static ScoreComponent	of(@NonNull java.lang.String name, @NonNull java.lang.String objective) Creates a score component with a name and objective.
static ScoreComponent	of(@NonNull java.lang.String name, @NonNull java.lang.String objective, @Nullable java.lang.String value) Creates a score component with a name, objective, and optional value.
protected void	populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)
@NonNull ScoreComponent	resetStyle() Resets all styling on this component.
@NonNull ScoreComponent.Builder	toBuilder() Create a builder from this component.
@Nullable java.lang.String	value() Gets the value.

Methods inherited from class net.kyori.text.AbstractComponent

children, clickEvent, color, decoration, equals, hasStyling, hoverEvent, insertion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.text.Component

children, clickEvent, color, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, of, of, of, of, of, of

Constructor Detail

ScoreComponent

protected ScoreComponent(@NonNull ScoreComponent.Builder builder)

ScoreComponent

protected ScoreComponent(@NonNull java.util.List<Component> children,
                         @Nullable TextColor color,
                         TextDecoration.State obfuscated,
                         TextDecoration.State bold,
                         TextDecoration.State strikethrough,
                         TextDecoration.State underlined,
                         TextDecoration.State italic,
                         @Nullable ClickEvent clickEvent,
                         @Nullable HoverEvent hoverEvent,
                         @Nullable java.lang.String insertion,
                         @NonNull java.lang.String name,
                         @NonNull java.lang.String objective,
                         @Nullable java.lang.String value)

Method Detail

builder

public static ScoreComponent.Builder builder()

Creates a score component builder.

Returns:

a builder

builder

public static ScoreComponent.Builder builder(@NonNull java.lang.String name,
                                             @NonNull java.lang.String objective)

Creates a score component builder with a name and objective.

Parameters:

name - the score name

objective - the score objective

Returns:

a builder

of

public static ScoreComponent of(@NonNull java.lang.String name,
                                @NonNull java.lang.String objective)

Creates a score component with a name and objective.

Parameters:

name - the score name

objective - the score objective

Returns:

the score component

of

public static ScoreComponent of(@NonNull java.lang.String name,
                                @NonNull java.lang.String objective,
                                @Nullable java.lang.String value)

Creates a score component with a name, objective, and optional value.

Parameters:

name - the score name

objective - the score objective

value - the value

Returns:

the score component

name

public @NonNull java.lang.String name()

Gets the score name.

Returns:

the score name

name

public @NonNull ScoreComponent name(@NonNull java.lang.String name)

Sets the score name.

Parameters:

name - the score name

Returns:

a copy of this component

objective

public @NonNull java.lang.String objective()

Gets the objective name.

Returns:

the objective name

objective

public @NonNull ScoreComponent objective(@NonNull java.lang.String objective)

Sets the score objective.

Parameters:

objective - the score objective

Returns:

a copy of this component

value

public @Nullable java.lang.String value()

Gets the value.

Returns:

the value

content

public @NonNull ScoreComponent content(@NonNull java.lang.String value)

Sets the value.

Parameters:

value - the value

Returns:

a copy of this component

append

public @NonNull ScoreComponent append(@NonNull Component component)

Description copied from interface: Component

Appends a component to this component.

Parameters:

component - the component to append

Returns:

a component with the component added

color

public @NonNull ScoreComponent color(@Nullable TextColor color)

Description copied from interface: Component

Sets the color of this component.

Parameters:

color - the color

Returns:

a component

decoration

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

Description copied from interface: Component

Sets the state of a decoration on this component.

Parameters:

decoration - the decoration

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

Returns:

a component

decoration

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

Description copied from interface: Component

Sets the value of a decoration on this component.

Parameters:

decoration - the decoration

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

Returns:

a component

clickEvent

public @NonNull ScoreComponent clickEvent(@Nullable ClickEvent event)

Description copied from interface: Component

Sets the click event of this component.

Parameters:

event - the click event

Returns:

a component

hoverEvent

public @NonNull ScoreComponent hoverEvent(@Nullable HoverEvent event)

Description copied from interface: Component

Sets the hover event of this component.

Parameters:

event - the hover event

Returns:

a component

insertion

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

Description copied from interface: Component

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

Parameters:

insertion - the insertion string

Returns:

a component

mergeStyle

public @NonNull ScoreComponent mergeStyle(@NonNull Component that)

Description copied from interface: Component

Merges styling from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeColor

public @NonNull ScoreComponent mergeColor(@NonNull Component that)

Description copied from interface: Component

Merges the color from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeDecorations

public @NonNull ScoreComponent mergeDecorations(@NonNull Component that)

Description copied from interface: Component

Merges the decorations from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeEvents

public @NonNull ScoreComponent mergeEvents(@NonNull Component that)

Description copied from interface: Component

Merges the events from another component into this component.

Parameters:

that - the other component

Returns:

a component

resetStyle

public @NonNull ScoreComponent resetStyle()

Description copied from interface: Component

Resets all styling on this component.

Returns:

a component

copy

public @NonNull ScoreComponent copy()

Description copied from interface: Component

Creates a component.

Returns:

a component

equals

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

Overrides:

equals in class AbstractComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractComponent

populateToString

protected void populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)

Overrides:

populateToString in class AbstractComponent

toBuilder

public @NonNull ScoreComponent.Builder toBuilder()

Description copied from interface: BuildableComponent

Create a builder from this component.

Returns:

the builder