org.pircbotx.hooks

Class Event

java.lang.Object

org.pircbotx.hooks.Event

All Implemented Interfaces:

Comparable<Event>, GenericEvent

Direct Known Subclasses:

ActionEvent, BanListEvent, ChannelInfoEvent, ConnectAttemptFailedEvent, ConnectEvent, DisconnectEvent, ExceptionEvent, FingerEvent, HalfOpEvent, IncomingChatRequestEvent, IncomingFileTransferEvent, InviteEvent, JoinEvent, KickEvent, MessageEvent, ModeEvent, MotdEvent, NickAlreadyInUseEvent, NickChangeEvent, NoticeEvent, OpEvent, OutputEvent, OwnerEvent, PartEvent, PingEvent, PrivateMessageEvent, QuitEvent, RemoveChannelBanEvent, RemoveChannelKeyEvent, RemoveChannelLimitEvent, RemoveInviteOnlyEvent, RemoveModeratedEvent, RemoveNoExternalMessagesEvent, RemovePrivateEvent, RemoveSecretEvent, RemoveTopicProtectionEvent, ServerPingEvent, ServerResponseEvent, SetChannelBanEvent, SetChannelKeyEvent, SetChannelLimitEvent, SetInviteOnlyEvent, SetModeratedEvent, SetNoExternalMessagesEvent, SetPrivateEvent, SetSecretEvent, SetTopicProtectionEvent, SocketConnectEvent, SuperOpEvent, TimeEvent, TopicEvent, UnknownEvent, UserListEvent, UserModeEvent, VersionEvent, VoiceEvent, WhoisEvent

public abstract class Event
extends Object
implements GenericEvent

An event representing what was received from the IRC server.

Author:

Leon Blakey

Constructor Summary

Constructors

Constructor and Description
Event(PircBotX bot)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Event other) Compare events by getTimestamp() and then getId() to order by when they are received.
boolean	equals(Object o)
<T extends PircBotX> T	getBot() The PircBotX instance that this event originally came from
long	getId() Returns the id of this event generated by incrementing an instance counter
long	getTimestamp() Returns the millisecond when the event was created.
int	hashCode()
abstract void	respond(String response) A simple abstract method that all events must implement to respond to an event happening.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Event

public Event(PircBotX bot)

Method Detail

respond

public abstract void respond(String response)

A simple abstract method that all events must implement to respond to an event happening. All implementing classes should delegate to the sendMessage or other relevant methods in the main PircBotX class, not with custom lines and calls to the send() methods

Specified by:

respond in interface GenericEvent

Parameters:

response - The response to send

compareTo

public int compareTo(Event other)

Compare events by getTimestamp() and then getId() to order by when they are received. This is useful for sorting lists of Channel objects.

Specified by:

compareTo in interface Comparable<Event>

Parameters:

other - Other Event to compare to

Returns:

the result of the comparison

getBot

public <T extends PircBotX> T getBot()

Description copied from interface: GenericEvent

The PircBotX instance that this event originally came from

Specified by:

getBot in interface GenericEvent

Returns:

A PircBotX instance

getTimestamp

@Generated(value="lombok")
public long getTimestamp()

Returns the millisecond when the event was created.

Specified by:

getTimestamp in interface GenericEvent

Returns:

A timestamp as a long

See Also:

System.currentTimeMillis()

getId

@Generated(value="lombok")
public long getId()

Returns the id of this event generated by incrementing an instance counter

Returns:

The id of this event

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Object