org.spongepowered.api.text.channel.impl

Class DelegateMessageChannel

java.lang.Object

org.spongepowered.api.text.channel.impl.DelegateMessageChannel

All Implemented Interfaces:

MessageChannel

public class DelegateMessageChannel
extends Object
implements MessageChannel

An immutable message channel that leaves transforming and members to the delegate channel passed.

The delegate channel may be immutable or mutable.

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageChannel	delegate

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

TO_ALL, TO_CONSOLE, TO_NONE, TO_PLAYERS

Constructor Summary

Constructors

Constructor and Description
DelegateMessageChannel(MessageChannel delegate) Creates a delegate MessageChannel that delegates all functions to the delegated message channel.

Method Summary

Modifier and Type	Method and Description
Collection<MessageReceiver>	getMembers() Gets a collection of all members in this channel.
Optional<Text>	transformMessage(Object sender, MessageReceiver recipient, Text original, ChatType type) Handle transforming the input message appropriately.

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.MessageChannel

asMutable, combined, combined, fixed, fixed, permission, send, send, send, send, world

Field Detail

delegate

protected final MessageChannel delegate

Constructor Detail

DelegateMessageChannel

public DelegateMessageChannel(MessageChannel delegate)

Creates a delegate MessageChannel that delegates all functions to the delegated message channel.

Parameters:

delegate - The delegated message channel

Method Detail

transformMessage

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

Description copied from interface: MessageChannel

Handle transforming the input message appropriately.

Specified by:

transformMessage in interface MessageChannel

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

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