Package org.kingdoms.locale.compiler.builders

Interface MessageObjectBuilder

All Known Implementing Classes:

CombinedMessageObject, ContextualMessageObject, LanguageEntryWithContext, MessageObject, MessageObjectLinker, RawLanguageEntryObjectBuilder

public interface MessageObjectBuilder

Builds a compiled message object.

Method Summary

Modifier and Type	Method	Description
void	build(ComplexMessageBuilderContextProvider contextProvider)
void	build(HTMLMessageBuilderContextProvider contextProvider)
void	build(PlainMessageBuilderContextProvider contextProvider)
default XComponentBuilder	buildComplex(MessagePlaceholderProvider settings)
default String	buildPlain(MessagePlaceholderProvider settings)
MessageObject	evaluateDynamicPieces(MessagePlaceholderProvider placeholderContextProvider)	Evaluates MessagePiece.Variable into their own individual pieces after being translated.
boolean	isAvailable(MessagePlaceholderProvider builder)	Whether any of this message object's methods can be used.

Method Details

build

void build(ComplexMessageBuilderContextProvider contextProvider)

build

void build(PlainMessageBuilderContextProvider contextProvider)

build

void build(HTMLMessageBuilderContextProvider contextProvider)

isAvailable

boolean isAvailable(MessagePlaceholderProvider builder)

Whether any of this message object's methods can be used.

evaluateDynamicPieces

MessageObject evaluateDynamicPieces(MessagePlaceholderProvider placeholderContextProvider)

Evaluates MessagePiece.Variable into their own individual pieces after being translated. This is useful for knowing the exact length and structure of the message which can be used to obtain the last colors in a message which itself is useful for multi-line situations such as color in items.

buildComplex

default XComponentBuilder buildComplex(MessagePlaceholderProvider settings)

buildPlain

default String buildPlain(MessagePlaceholderProvider settings)