net.kyori.text.renderer

Class FriendlyComponentRenderer<C>

java.lang.Object

net.kyori.text.renderer.FriendlyComponentRenderer<C>

All Implemented Interfaces:

ComponentRenderer<C>

public abstract class FriendlyComponentRenderer<C>
extends java.lang.Object
implements ComponentRenderer<C>

A friendly component renderer.

Constructor Summary

Constructors

Constructor and Description
FriendlyComponentRenderer()

Method Summary

Modifier and Type	Method and Description
static <C> @NonNull FriendlyComponentRenderer<C>	from(@NonNull java.util.function.BiFunction<C,java.lang.String,java.text.MessageFormat> translations)
@NonNull Component	render(@NonNull Component component, C context) Renders a component.
protected abstract @Nullable java.text.MessageFormat	translation(C context, @NonNull java.lang.String key) Gets a translation for a translation key in the given context.

Methods inherited from class java.lang.Object

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

Constructor Detail

FriendlyComponentRenderer

public FriendlyComponentRenderer()

Method Detail

from

public static <C> @NonNull FriendlyComponentRenderer<C> from(@NonNull java.util.function.BiFunction<C,java.lang.String,java.text.MessageFormat> translations)

render

public @NonNull Component render(@NonNull Component component,
                                 C context)

Description copied from interface: ComponentRenderer

Renders a component.

Specified by:

render in interface ComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

translation

protected abstract @Nullable java.text.MessageFormat translation(C context,
                                                                 @NonNull java.lang.String key)

Gets a translation for a translation key in the given context.

Parameters:

context - the context

key - the translation key

Returns:

the translation