Package net.kyori.adventure.text

Class AbstractComponent

java.lang.Object

net.kyori.adventure.text.AbstractComponent

All Implemented Interfaces:

Component, ComponentBuilderApplicable, ComponentLike, HoverEventSource<Component>, net.kyori.examination.Examinable

public abstract class AbstractComponent
extends Object
implements Component

An abstract implementation of a text component.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Component>	children	The list of children.
protected Style	style	The style of this component.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComponent(@NonNull List<? extends ComponentLike> children, @NonNull Style style)

Method Summary

Modifier and Type	Method	Description
@NonNull List<Component>	children()	Gets the unmodifiable list of children.
boolean	equals(@Nullable Object other)
@NonNull Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
int	hashCode()
@NonNull Component	replaceText(@NonNull Pattern pattern, @NonNull Function<TextComponent.Builder,@Nullable ComponentLike> replacement, @NonNull IntFunction2<PatternReplacementResult> fn)	Finds and replaces text using a regex pattern.
@NonNull Style	style()	Gets the style of this component.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.adventure.text.Component

append, append, append, asComponent, asHoverEvent, children, clickEvent, clickEvent, color, color, colorIfAbsent, componentBuilderApply, contains, decorate, decoration, decoration, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, hoverEvent, insertion, insertion, mergeStyle, mergeStyle, mergeStyle, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, style, style, style, style

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Field Details

children

protected final List<Component> children

The list of children.

style

protected final Style style

The style of this component.

Constructor Details

AbstractComponent

protected AbstractComponent(@NonNull List<? extends ComponentLike> children, @NonNull Style style)

Method Details

children

public final @NonNull List<Component> children()

Description copied from interface: Component

Gets the unmodifiable list of children.

Specified by:

children in interface Component

Returns:

the unmodifiable list of children

style

public final @NonNull Style style()

Description copied from interface: Component

Gets the style of this component.

Specified by:

style in interface Component

Returns:

the style of this component

replaceText

public @NonNull Component replaceText(@NonNull Pattern pattern, @NonNull Function<TextComponent.Builder,@Nullable ComponentLike> replacement, @NonNull IntFunction2<PatternReplacementResult> fn)

Description copied from interface: Component

Finds and replaces text using a regex pattern.

Utilises an IntFunction2 to determine if each instance should be replaced.

Specified by:

replaceText in interface Component

Parameters:

pattern - a regex pattern

replacement - a function to replace the first match

fn - a function of (index, replaced) used to determine if matches should be replaced, where "replaced" is the number of successful replacements

Returns:

a modified copy of this component

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

examinableProperties

public @NonNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface net.kyori.examination.Examinable

toString

public String toString()

Overrides:

toString in class Object