Package cz.foresttech.forestredis.spigot.events

Class RedisMessageReceivedEvent

java.lang.Object

org.bukkit.event.Event

cz.foresttech.forestredis.spigot.events.RedisMessageReceivedEvent

All Implemented Interfaces:

IRedisMessageReceivedEvent

public class RedisMessageReceivedEvent
extends org.bukkit.event.Event
implements IRedisMessageReceivedEvent

Spigot Event class used when message was received from subscribed channel.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
RedisMessageReceivedEvent(String channel, MessageTransferObject messageTransferObject)	Constructs the instance of the Event

Method Summary

Modifier and Type	Method	Description
static org.bukkit.event.HandlerList	getHandlerList()
org.bukkit.event.HandlerList	getHandlers()
String	getChannel()	Obtains the name of the channel message came from
String	getMessage()	Obtains message received
<T> T	getMessageObject(Class<T> objectClass)	Obtains object from received message by provided type
String	getSenderIdentifier()	Obtains the sender's identifier
long	getTimeStamp()	Obtains message timestamp
boolean	isSelfSender()	Checks if the sender server has the same identifier as current server

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

RedisMessageReceivedEvent

public RedisMessageReceivedEvent(String channel,
 MessageTransferObject messageTransferObject)

Constructs the instance of the Event

Parameters:

channel - Channel in which was the message published

messageTransferObject - MessageTransferObject object containing data about published message

Method Details

getSenderIdentifier

public String getSenderIdentifier()

Description copied from interface: IRedisMessageReceivedEvent

Obtains the sender's identifier

Specified by:

getSenderIdentifier in interface IRedisMessageReceivedEvent

Returns:

Sender server's name

getChannel

public String getChannel()

Description copied from interface: IRedisMessageReceivedEvent

Obtains the name of the channel message came from

Specified by:

getChannel in interface IRedisMessageReceivedEvent

Returns:

Name of the incoming channel

getMessage

public String getMessage()

Description copied from interface: IRedisMessageReceivedEvent

Obtains message received

Specified by:

getMessage in interface IRedisMessageReceivedEvent

Returns:

Message received

getMessageObject

public <T> T getMessageObject(Class<T> objectClass)

Description copied from interface: IRedisMessageReceivedEvent

Obtains object from received message by provided type

Specified by:

getMessageObject in interface IRedisMessageReceivedEvent

Type Parameters:

T - Object type

Parameters:

objectClass - Object class

Returns:

Parsed object (null if it cannot be parsed)

isSelfSender

public boolean isSelfSender()

Description copied from interface: IRedisMessageReceivedEvent

Checks if the sender server has the same identifier as current server

Specified by:

isSelfSender in interface IRedisMessageReceivedEvent

Returns:

Whether the message was sent by this server

getTimeStamp

public long getTimeStamp()

Description copied from interface: IRedisMessageReceivedEvent

Obtains message timestamp

Specified by:

getTimeStamp in interface IRedisMessageReceivedEvent

Returns:

TimeStamp of the message

getHandlers

public org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()