Package ovh.mythmc.social.api.chat.renderer.feature

Class ChatRendererFeature

java.lang.Object

ovh.mythmc.social.api.chat.renderer.feature.ChatRendererFeature

public class ChatRendererFeature
extends Object

Represents a feature that can be applied when rendering chat messages.

A ChatRendererFeature encapsulates:

• a ChatRendererFeature.Handler that modifies the message format before rendering,
• a ChatRendererFeature.Decorator that can modify the Component visually,
• a Predicate condition that determines whether this feature applies to a given message context.

Features can be created using the static builder(Handler) method or with specialized helper methods such as replies(int) and companion(). Builders allow additional customization of the condition and decorator before building the final feature.

Usage Example:

 ChatRendererFeature repliesFeature = ChatRendererFeature.replies(0);
 ChatRendererFeature companionFeature = ChatRendererFeature.companion();
 

See Also:

• builder(Handler)
• replies(int)
• companion()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChatRendererFeature.Builder<T extends ChatRendererFeature.Builder<T,R>,R extends ChatRendererFeature>	Builder for ChatRendererFeature.
static final class	ChatRendererFeature.ChatFeatureBuilder	Builder implementation for simple chat features.
static interface	ChatRendererFeature.Decorator	Functional interface representing a decorator that can visually modify a message's Component.
static interface	ChatRendererFeature.Handler	Functional interface representing a handler that modifies a message's format before rendering.

Method Summary

Modifier and Type	Method	Description
static ChatRendererFeature.ChatFeatureBuilder	builder(@NotNull ChatRendererFeature.Handler handler)	Creates a builder for a custom chat feature.
static ChatRendererFeature	companion()	Returns a feature that appends companion-related components to messages, if the sender has a companion.
ChatRendererFeature.Decorator	decorator()	Returns the ChatRendererFeature.Decorator of this feature.
ChatRendererFeature.Handler	handler()	Returns the ChatRendererFeature.Handler of this feature.
boolean	isApplicable(@NotNull SocialRegisteredMessageContext context)	Tests whether this feature is applicable to a given message context.
static ChatRendererFeature	replies(int injectionIndex)	Returns a feature that renders reply icons for messages that are replies.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static ChatRendererFeature.ChatFeatureBuilder builder(@NotNull
 @NotNull ChatRendererFeature.Handler handler)

Creates a builder for a custom chat feature.

Parameters:

handler - the handler to modify the message format

Returns:

a ChatRendererFeature.ChatFeatureBuilder for configuring decorators and conditions

replies

public static ChatRendererFeature replies(int injectionIndex)

Returns a feature that renders reply icons for messages that are replies.

Parameters:

injectionIndex - the index in the format to inject the reply icon

Returns:

a ChatRendererFeature that applies reply icons

companion

public static ChatRendererFeature companion()

Returns a feature that appends companion-related components to messages, if the sender has a companion.

Returns:

a ChatRendererFeature for rendering companions

handler

public ChatRendererFeature.Handler handler()

Returns the ChatRendererFeature.Handler of this feature.

decorator

public ChatRendererFeature.Decorator decorator()

Returns the ChatRendererFeature.Decorator of this feature.

isApplicable

public boolean isApplicable(@NotNull
 @NotNull SocialRegisteredMessageContext context)

Tests whether this feature is applicable to a given message context.

Parameters:

context - the SocialRegisteredMessageContext to test

Returns:

true if this feature applies, false otherwise