net.lenni0451.mcstructs.text

Class ATextComponent

java.lang.Object

net.lenni0451.mcstructs.text.ATextComponent

All Implemented Interfaces:

net.lenni0451.mcstructs.core.ICopyable<ATextComponent>

Direct Known Subclasses:

KeybindComponent, NbtComponent, ScoreComponent, SelectorComponent, StringComponent, TranslationComponent

public abstract class ATextComponent
extends java.lang.Object
implements net.lenni0451.mcstructs.core.ICopyable<ATextComponent>

The base text component class.
Implementations of this class are:
- StringComponent
- TranslationComponent
- ScoreComponent
- SelectorComponent
- KeybindComponent
- BlockNbtComponent
- EntityNbtComponent
- StorageNbtComponent

Constructor Summary

Constructors

Constructor and Description
ATextComponent()

Method Summary

Modifier and Type	Method and Description
ATextComponent	append(ATextComponent... components) Append multiple components to this component.
ATextComponent	append(ATextComponent component) Append a component to this component.
ATextComponent	append(java.lang.String s) Append a string to this component.
java.lang.String	asLegacyFormatString()
abstract java.lang.String	asSingleString()
java.lang.String	asUnformattedString()
abstract ATextComponent	copy()
ATextComponent	copyParentStyle() Set the style of this component as the parent style for all siblings.
abstract boolean	equals(java.lang.Object o)
ATextComponent	forEach(java.util.function.Consumer<ATextComponent> consumer) Iterate over all components and their siblings.
java.util.List<ATextComponent>	getSiblings()
Style	getStyle()
abstract int	hashCode()
<C extends ATextComponent> C	putMetaCopy(C component) Copy the style and siblings of this component to the given component.
ATextComponent	setParentStyle(Style style) Set the parent style of this component.
ATextComponent	setStyle(Style style) Set the style of this component.
abstract java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ATextComponent

public ATextComponent()

Method Detail

append

public ATextComponent append(java.lang.String s)

Append a string to this component.

Parameters:

s - The string to append

Returns:

This component

append

public ATextComponent append(ATextComponent component)

Append a component to this component.

Parameters:

component - The component to append

Returns:

This component

append

public ATextComponent append(ATextComponent... components)

Append multiple components to this component.

Parameters:

components - The components to append

Returns:

This component

getSiblings

public java.util.List<ATextComponent> getSiblings()

Returns:

The siblings of this component

forEach

public ATextComponent forEach(java.util.function.Consumer<ATextComponent> consumer)

Iterate over all components and their siblings.

Parameters:

consumer - The consumer that will be called for every component

Returns:

This component

getStyle

@Nonnull
public Style getStyle()

Returns:

The style of this component

setStyle

public ATextComponent setStyle(@Nonnull
                               Style style)

Set the style of this component.

Parameters:

style - The new style

Returns:

This component

setParentStyle

public ATextComponent setParentStyle(@Nonnull
                                     Style style)

Set the parent style of this component.

Parameters:

style - The new parent style

Returns:

This component

copyParentStyle

public ATextComponent copyParentStyle()

Set the style of this component as the parent style for all siblings.

Returns:

This component

putMetaCopy

public <C extends ATextComponent> C putMetaCopy(C component)

Copy the style and siblings of this component to the given component.

Type Parameters:

C - The type of the component

Parameters:

component - The component to copy to

Returns:

The given component

asUnformattedString

public java.lang.String asUnformattedString()

Returns:

An unformatted string representation of this component

asLegacyFormatString

public java.lang.String asLegacyFormatString()

Returns:

A legacy formatted string representation of this component

asSingleString

public abstract java.lang.String asSingleString()

Returns:

An unformatted string representation of this component

copy

public abstract ATextComponent copy()

Specified by:

copy in interface net.lenni0451.mcstructs.core.ICopyable<ATextComponent>

equals

public abstract boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object