org.panda_lang.framework.design.interpreter.messenger

Interface MessengerFormatter

public interface MessengerFormatter

Message formatter

Method Summary

Modifier and Type	Method and Description
MessengerFormatter	fork() Clone formatter into a new instance
String	format(String message, Collection<Object> context) Format message using registered placeholders and with provided data
Messenger	getMessenger() Get Messenger
<T> MessengerTypeFormatter<T>	getTypeFormatter(Class<T> type) Register group of placeholders associated with the specified type
<T> MessengerFormatter	register(String placeholder, @Nullable Class<T> requiredData, FormatterFunction<?> replacementFunction) Register a new placeholder

Method Detail

format

String format(String message,
              Collection<Object> context)

Format message using registered placeholders and with provided data

Parameters:

message - the message to format

context - the values to use as data for placeholders

Returns:

formatted message

register

<T> MessengerFormatter register(String placeholder,
                                @Nullable
                                @Nullable Class<T> requiredData,
                                FormatterFunction<?> replacementFunction)

Register a new placeholder

Type Parameters:

T - type of required data

Parameters:

placeholder - the name of the placeholder

requiredData - the required type of data to use that placeholder (if null, it means that placeholder does not require provided context)

replacementFunction - the value to replace with

Returns:

the instance of formatter

getTypeFormatter

<T> MessengerTypeFormatter<T> getTypeFormatter(Class<T> type)

Register group of placeholders associated with the specified type

Type Parameters:

T - type

Parameters:

type - the type of the group

Returns:

instance of type formatter

fork

MessengerFormatter fork()

Clone formatter into a new instance

Returns:

the new instance

getMessenger

Messenger getMessenger()

Get Messenger

Returns:

the messenger instance