Package ovh.mythmc.social.api.chat.format

Class ChatFormatBuilder

java.lang.Object

ovh.mythmc.social.api.chat.format.ChatFormatBuilder

public final class ChatFormatBuilder
extends Object

Builds the prefix component for a ChatChannel.

A format is assembled by appending SocialInjectedValue slots in order. Static text components are wrapped with append(TextComponent), while context-dependent elements can use appendConditional(TextComponent, java.util.function.Predicate) or arbitrary SocialInjectedValue instances via injectValue(SocialInjectedValue).

Method Summary

Modifier and Type	Method	Description
ChatFormatBuilder	append(@NotNull TextComponent component)	Appends a static text component as a literal injected value.
ChatFormatBuilder	append(@NotNull TextComponent component, int index)	Inserts a static text component as a literal injected value at the given index.
ChatFormatBuilder	appendConditional(@NotNull TextComponent component, @NotNull Predicate<SocialParserContext> predicate)	Appends a conditional text component; it is only rendered when predicate evaluates to true for the current parser context.
ChatFormatBuilder	appendConditional(@NotNull TextComponent component, @NotNull Predicate<SocialParserContext> predicate, int index)	Inserts a conditional text component at the given index; it is only rendered when predicate evaluates to true for the current parser context.
ChatFormatBuilder	appendSpace()	Appends a single space as a literal injected value.
static ChatFormatBuilder	empty()	Creates an empty format with no injected values.
static ChatFormatBuilder	from(@NotNull TextComponent base)	Creates a format pre-populated with the given text component.
ChatFormatBuilder	injectValue(@NotNull SocialInjectedValue<?,?> injectedValue)	Appends a single injected value to the end of this format.
ChatFormatBuilder	injectValue(@NotNull SocialInjectedValue<?,?> injectedValue, int index)	Inserts a single injected value at the given index.
ChatFormatBuilder	injectValues(@NotNull Iterable<? extends SocialInjectedValue<?,?>> injectedValues)	Appends each of the given injected values to this format.
Component	preRenderPrefix(@NotNull SocialUser target, @NotNull Iterable<? extends ChatRendererFeature> supportedFeatures, @NotNull SocialRegisteredMessageContext message, @NotNull SocialParserContext parser)	Evaluates all renderer features and then renders the full prefix component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

empty

public static ChatFormatBuilder empty()

Creates an empty format with no injected values.

Returns:

an empty builder

from

public static ChatFormatBuilder from(@NotNull
 @NotNull TextComponent base)

Creates a format pre-populated with the given text component.

Parameters:

base - the initial component

Returns:

a builder with the component appended

injectValues

public ChatFormatBuilder injectValues(@NotNull
 @NotNull Iterable<? extends SocialInjectedValue<?,?>> injectedValues)

Appends each of the given injected values to this format.

Parameters:

injectedValues - the values to append

Returns:

this builder

injectValue

public ChatFormatBuilder injectValue(@NotNull
 @NotNull SocialInjectedValue<?,?> injectedValue)

Appends a single injected value to the end of this format.

Parameters:

injectedValue - the value to append

Returns:

this builder

injectValue

public ChatFormatBuilder injectValue(@NotNull
 @NotNull SocialInjectedValue<?,?> injectedValue,
 int index)

Inserts a single injected value at the given index.

Parameters:

injectedValue - the value to insert

index - the position to insert at

Returns:

this builder

append

public ChatFormatBuilder append(@NotNull
 @NotNull TextComponent component,
 int index)

Inserts a static text component as a literal injected value at the given index.

Parameters:

component - the component to insert

index - the position to insert at

Returns:

this builder

append

public ChatFormatBuilder append(@NotNull
 @NotNull TextComponent component)

Appends a static text component as a literal injected value.

Parameters:

component - the component to append

Returns:

this builder

appendConditional

public ChatFormatBuilder appendConditional(@NotNull
 @NotNull TextComponent component,
 @NotNull
 @NotNull Predicate<SocialParserContext> predicate,
 int index)

Inserts a conditional text component at the given index; it is only rendered when predicate evaluates to true for the current parser context.

Parameters:

component - the component to show when the predicate matches

predicate - the condition under which the component is rendered

index - the position to insert at

Returns:

this builder

appendConditional

public ChatFormatBuilder appendConditional(@NotNull
 @NotNull TextComponent component,
 @NotNull
 @NotNull Predicate<SocialParserContext> predicate)

Appends a conditional text component; it is only rendered when predicate evaluates to true for the current parser context.

Parameters:

component - the component to show when the predicate matches

predicate - the condition under which the component is rendered

Returns:

this builder

appendSpace

public ChatFormatBuilder appendSpace()

Appends a single space as a literal injected value.

Returns:

this builder

preRenderPrefix

public Component preRenderPrefix(@NotNull
 @NotNull SocialUser target,
 @NotNull
 @NotNull Iterable<? extends ChatRendererFeature> supportedFeatures,
 @NotNull
 @NotNull SocialRegisteredMessageContext message,
 @NotNull
 @NotNull SocialParserContext parser)

Evaluates all renderer features and then renders the full prefix component.

This is called internally by ChatChannel.prefix(SocialUser, SocialRegisteredMessageContext, SocialParserContext) implementations and should not normally be invoked directly from plugin code.

Parameters:

target - the player the prefix is being rendered for

supportedFeatures - the renderer features active on the channel

message - the registered message context

parser - the parser context, which receives the injected values

Returns:

the fully resolved prefix component