org.spongepowered.api.text.channel

Class AbstractMutableMessageChannel

java.lang.Object

org.spongepowered.api.text.channel.AbstractMutableMessageChannel

All Implemented Interfaces:

MessageChannel, MutableMessageChannel

Direct Known Subclasses:

DelegateMutableMessageChannel, SimpleMutableMessageChannel

public abstract class AbstractMutableMessageChannel
extends Object
implements MutableMessageChannel

An abstract implementation of MutableMessageChannel.

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<MessageReceiver>	members

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

TO_ALL, TO_CONSOLE, TO_NONE, TO_PLAYERS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMutableMessageChannel() The default implementation uses a WeakHashMap implementation of Set.
protected	AbstractMutableMessageChannel(Collection<MessageReceiver> members) Creates a new instance of AbstractMutableMessageChannel with the provided Collection as the underlying member list.

Method Summary

Modifier and Type	Method and Description
boolean	addMember(MessageReceiver member) Adds a member to this channel.
void	clearMembers() Removes all of the members from this channel.
Collection<MessageReceiver>	getMembers() Gets a collection of all members in this channel.
boolean	removeMember(MessageReceiver member) Removes a member from this channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

asMutable

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

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

Field Detail

members

protected final Collection<MessageReceiver> members

Constructor Detail

AbstractMutableMessageChannel

protected AbstractMutableMessageChannel()

The default implementation uses a WeakHashMap implementation of Set.

AbstractMutableMessageChannel

protected AbstractMutableMessageChannel(Collection<MessageReceiver> members)

Creates a new instance of AbstractMutableMessageChannel with the provided Collection as the underlying member list.

The passed Collection directly affects the members of this channel.

It is recommended to use a weak collection to avoid memory leaks. If you do not use a weak collection, please ensure that members are cleaned up properly.

Parameters:

members - The collection of members

Method Detail

addMember

public boolean addMember(MessageReceiver member)

Description copied from interface: MutableMessageChannel

Adds a member to this channel.

Specified by:

addMember in interface MutableMessageChannel

Parameters:

member - The member to add

Returns:

true if this channel did not already contain the member

removeMember

public boolean removeMember(MessageReceiver member)

Description copied from interface: MutableMessageChannel

Removes a member from this channel.

Specified by:

removeMember in interface MutableMessageChannel

Parameters:

member - The member to remove

Returns:

true if this channel contained the specified member

clearMembers

public void clearMembers()

Description copied from interface: MutableMessageChannel

Removes all of the members from this channel.

Specified by:

clearMembers in interface MutableMessageChannel

getMembers

public Collection<MessageReceiver> getMembers()

Description copied from interface: MessageChannel

Gets a collection of all members in this channel.

Specified by:

getMembers in interface MessageChannel

Returns:

A collection of all members of this channel