Package nl.pim16aap2.animatedarchitecture.core.api

Interface IMessageable

All Known Subinterfaces:

ICommandSender, IPlayer, IServer

All Known Implementing Classes:

IMessageable.BlackHoleMessageable, OfflinePlayerSpigot, PlayerSpigot, SpigotServer

public interface IMessageable

Represents objects that can receive messages.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IMessageable.BlackHoleMessageable	Implementation of IMessageable that does not send messages anywhere.

Field Summary

Fields

Modifier and Type	Field	Description
static final IMessageable	NULL	Instance of IMessageable.BlackHoleMessageable that can be used in case messages should not be sent anywhere.

Method Summary

Modifier and Type	Method	Description
default void	sendError(ITextFactory textFactory, String message)	Sends an error message to this object.
default void	sendInfo(ITextFactory textFactory, String message)	Sends a info message to this object.
default void	sendMessage(ITextFactory textFactory, TextType textType, String message)	Sends a message to this object.
void	sendMessage(Text text)	Sends a message to this object.
default void	sendSuccess(ITextFactory textFactory, String message)	Sends a success message to this object.

Field Details

NULL

static final IMessageable NULL

Instance of IMessageable.BlackHoleMessageable that can be used in case messages should not be sent anywhere.

Method Details

sendMessage

void sendMessage(Text text)

Sends a message to this object.

Parameters:

text - The message to send. This may or may not contain formatting.

sendMessage

default void sendMessage(ITextFactory textFactory,
 TextType textType,
 String message)

Sends a message to this object.

Parameters:

textFactory - The ITextFactory to use for creating the Text object.

textType - The TextType to use for the message to send.

message - The message to send.

sendError

default void sendError(ITextFactory textFactory,
 String message)

Sends an error message to this object.

Parameters:

textFactory - The ITextFactory to use for creating the Text object.

message - The error message to send.

sendSuccess

default void sendSuccess(ITextFactory textFactory,
 String message)

Sends a success message to this object.

Parameters:

textFactory - The ITextFactory to use for creating the Text object.

message - The success message to send.

sendInfo

default void sendInfo(ITextFactory textFactory,
 String message)

Sends a info message to this object.

Parameters:

textFactory - The ITextFactory to use for creating the Text object.

message - The info message to send.