org.spongepowered.api.text.channel

Interface MessageChannel

All Known Subinterfaces:

MutableMessageChannel

All Known Implementing Classes:

AbstractMutableMessageChannel, CombinedMessageChannel, DelegateMessageChannel, DelegateMutableMessageChannel, FixedMessageChannel, PermissionMessageChannel, SimpleMutableMessageChannel, WorldMessageChannel

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MessageChannel

Represents a channel that takes a message and transforms it for distribution to the members.

Field Summary

Fields

Modifier and Type	Field and Description
static MessageChannel	TO_ALL A channel with all online players, as well as the server console, as members.
static MessageChannel	TO_CONSOLE A channel with the server console as a member.
static MessageChannel	TO_NONE A channel with no members.
static MessageChannel	TO_PLAYERS A channel with all online players as members.

Method Summary

Modifier and Type	Method and Description
default MutableMessageChannel	asMutable() Gets or creates a mutable version of this channel.
static MessageChannel	combined(Collection<MessageChannel> channels) Gets a message channel that targets all subjects contained within the given channels and applies the message transformations of each channel in order.
static MessageChannel	combined(MessageChannel... channels) Creates a message channel that targets all subjects contained within the given channels and applies the message transformations of each channel in order.
static MessageChannel	fixed(Collection<? extends MessageReceiver> recipients) Creates a message channel that targets the given recipients.
static MessageChannel	fixed(MessageReceiver... recipients) Creates a message channel that targets the given sources.
Collection<MessageReceiver>	getMembers() Gets a collection of all members in this channel.
static MessageChannel	permission(String permission) Creates a message channel that targets all subjects with the given permission.
default void	send(Object sender, Text original) Send a message to this channel, transforming and sending it to the members.
default void	send(Object sender, Text original, ChatType type) Send a message to this channel, transforming and sending it to the members.
default void	send(Text original) Broadcast a message to this channel, transforming and sending it to the members.
default void	send(Text original, ChatType type) Sends a message to this channel, transforming and sending it to the members.
default Optional<Text>	transformMessage(Object sender, MessageReceiver recipient, Text original, ChatType type) Handle transforming the input message appropriately.
static MessageChannel	world(World world) Creates a message channel that targets the given world.

Field Detail

TO_NONE

static final MessageChannel TO_NONE

A channel with no members.

TO_PLAYERS

static final MessageChannel TO_PLAYERS

A channel with all online players as members.

TO_CONSOLE

static final MessageChannel TO_CONSOLE

A channel with the server console as a member.

TO_ALL

static final MessageChannel TO_ALL

A channel with all online players, as well as the server console, as members.

Method Detail

permission

static MessageChannel permission(String permission)

Creates a message channel that targets all subjects with the given permission.

Parameters:

permission - The permission to target

Returns:

The channel

See Also:

PermissionMessageChannel

combined

static MessageChannel combined(MessageChannel... channels)

Creates a message channel that targets all subjects contained within the given channels and applies the message transformations of each channel in order.

Parameters:

channels - The channels to combine

Returns:

The channel

See Also:

CombinedMessageChannel

combined

static MessageChannel combined(Collection<MessageChannel> channels)

Gets a message channel that targets all subjects contained within the given channels and applies the message transformations of each channel in order.

Parameters:

channels - The channels to combine

Returns:

The channel

See Also:

CombinedMessageChannel

fixed

static MessageChannel fixed(MessageReceiver... recipients)

Creates a message channel that targets the given sources.

Parameters:

recipients - The recipients

Returns:

The channel

See Also:

FixedMessageChannel

fixed

static MessageChannel fixed(Collection<? extends MessageReceiver> recipients)

Creates a message channel that targets the given recipients.

Parameters:

recipients - The recipients

Returns:

The channel

See Also:

FixedMessageChannel

world

static MessageChannel world(World world)

Creates a message channel that targets the given world.

Parameters:

world - The world

Returns:

The channel

See Also:

WorldMessageChannel

send

default void send(Text original)

Broadcast a message to this channel, transforming and sending it to the members.

Parameters:

original - The original text to send

send

default void send(Text original,
                  ChatType type)

Sends a message to this channel, transforming and sending it to the members.

By default, the ChatTypes.SYSTEM type is used when sending messages to applicable recipients of this channel.

Parameters:

original - The original text to send

type - The type of message

send

default void send(@Nullable
                  Object sender,
                  Text original)

Send a message to this channel, transforming and sending it to the members.

Parameters:

sender - The sender of the message

original - The original message to send

send

default void send(@Nullable
                  Object sender,
                  Text original,
                  ChatType type)

Send a message to this channel, transforming and sending it to the members.

Parameters:

sender - The sender of the message

original - The original message to send

type - The type of message

transformMessage

default Optional<Text> transformMessage(@Nullable
                                        Object sender,
                                        MessageReceiver recipient,
                                        Text original,
                                        ChatType type)

Handle transforming the input message appropriately.

Parameters:

sender - The sender of the message

recipient - The recipient of the message

original - The original message, to optionally transform

type - The type of message

Returns:

The message to send, if present, otherwise Optional.empty()

getMembers

Collection<MessageReceiver> getMembers()

Gets a collection of all members in this channel.

Returns:

A collection of all members of this channel

asMutable

default MutableMessageChannel asMutable()

Gets or creates a mutable version of this channel.

The default behaviour of this method is to copy the current member list into a DelegateMutableMessageChannel, which calls the transformMessage(Object, MessageReceiver, Text, ChatType) method on this channel.

Returns:

A mutable channel