org.spongepowered.api.text.channel

Interface MutableMessageChannel

All Superinterfaces:

MessageChannel

All Known Implementing Classes:

AbstractMutableMessageChannel, DelegateMutableMessageChannel, SimpleMutableMessageChannel

public interface MutableMessageChannel
extends MessageChannel

Represents a channel that takes a message and transforms it for distribution to a mutable list of members.

Field Summary

Fields inherited from interface org.spongepowered.api.text.channel.MessageChannel

TO_ALL, TO_CONSOLE, TO_NONE, TO_PLAYERS

Method Summary

Modifier and Type	Method and Description
boolean	addMember(MessageReceiver member) Adds a member to this channel.
default MutableMessageChannel	asMutable() Gets or creates a mutable version of this channel.
void	clearMembers() Removes all of the members from this channel.
boolean	removeMember(MessageReceiver member) Removes a member from this channel.

Methods inherited from interface org.spongepowered.api.text.channel.MessageChannel

combined, combined, fixed, fixed, getMembers, permission, send, send, send, send, transformMessage, world

Method Detail

addMember

boolean addMember(MessageReceiver member)

Adds a member to this channel.

Parameters:

member - The member to add

Returns:

true if this channel did not already contain the member

removeMember

boolean removeMember(MessageReceiver member)

Removes a member from this channel.

Parameters:

member - The member to remove

Returns:

true if this channel contained the specified member

clearMembers

void clearMembers()

Removes all of the members from this channel.

asMutable

default MutableMessageChannel asMutable()

Description copied from interface: MessageChannel

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 MessageChannel.transformMessage(Object, MessageReceiver, Text, ChatType) method on this channel.

Specified by:

asMutable in interface MessageChannel

Returns:

A mutable channel