org.spongepowered.api.text.channel.impl

Class DelegateMutableMessageChannel

java.lang.Object

org.spongepowered.api.text.channel.AbstractMutableMessageChannel

org.spongepowered.api.text.channel.impl.DelegateMutableMessageChannel

All Implemented Interfaces:

MessageChannel, MutableMessageChannel

public class DelegateMutableMessageChannel
extends AbstractMutableMessageChannel

A mutable message channel that leaves transforming and members to the delegate channel passed.

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageChannel	delegate

Fields inherited from class org.spongepowered.api.text.channel.AbstractMutableMessageChannel

members

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

TO_ALL, TO_CONSOLE, TO_NONE, TO_PLAYERS

Constructor Summary

Constructors

Constructor and Description
DelegateMutableMessageChannel(MessageChannel delegate) Constructs a delegate mutable message channel.

Method Summary

Modifier and Type	Method and Description
Optional<Text>	transformMessage(Object sender, MessageReceiver recipient, Text original, ChatType type) Handle transforming the input message appropriately.

Methods inherited from class org.spongepowered.api.text.channel.AbstractMutableMessageChannel

addMember, clearMembers, getMembers, removeMember

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, world

Field Detail

delegate

protected final MessageChannel delegate

Constructor Detail

DelegateMutableMessageChannel

public DelegateMutableMessageChannel(MessageChannel delegate)

Constructs a delegate mutable message channel.

The members from the provided channel are copied into our own local collection.

Parameters:

delegate - The delegate 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.

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()