org.kitteh.irc.client.library.event.abstractbase

Class ActorPrivateMessageEventBase<A extends Actor>

java.lang.Object

org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

org.kitteh.irc.client.library.event.abstractbase.ActorEventBase<A>

org.kitteh.irc.client.library.event.abstractbase.ActorMessageEventBase<A>

org.kitteh.irc.client.library.event.abstractbase.ActorPrivateMessageEventBase<A>

Type Parameters:

A - actor involved

All Implemented Interfaces:

ClientLinked, ActorEvent<A>, ClientEvent, MessageEvent, PrivateEvent, ServerMessageEvent

Direct Known Subclasses:

PrivateCtcpQueryEvent, PrivateCtcpReplyEvent, PrivateMessageEvent, PrivateNoticeEvent

public abstract class ActorPrivateMessageEventBase<A extends Actor>
extends ActorMessageEventBase<A>
implements PrivateEvent

Abstract base class for events involving an Actor and have a message and are private messages. Use the helper events if you want to listen to events involving either.

See Also:

ActorEvent, MessageEvent, PrivateEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActorPrivateMessageEventBase(@NonNull Client client, @NonNull ServerMessage sourceMessage, A actor, @NonNull String target, @NonNull String message) Constructs the event.

Method Summary

Modifier and Type	Method and Description
@NonNull String	getTarget() Gets the target of this message.
boolean	isToClient() Gets if the target of the message is this client.
protected @NonNull ToStringer	toStringer() Generates a partial ToStringer for the command.

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ActorMessageEventBase

getMessage

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ActorEventBase

getActor

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

getSource

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

getClient, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ServerMessageEvent

getSource, getTag, getTag, getTags

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Constructor Detail

ActorPrivateMessageEventBase

protected ActorPrivateMessageEventBase(@NonNull Client client,
                                       @NonNull ServerMessage sourceMessage,
                                       A actor,
                                       @NonNull String target,
                                       @NonNull String message)

Constructs the event.

Parameters:

client - the client

sourceMessage - source message

actor - the actor

target - target of the message

message - the message

Method Detail

getTarget

public @NonNull String getTarget()

Description copied from interface: PrivateEvent

Gets the target of this message.

Specified by:

getTarget in interface PrivateEvent

Returns:

the message target

isToClient

public boolean isToClient()

Description copied from interface: PrivateEvent

Gets if the target of the message is this client.

Specified by:

isToClient in interface PrivateEvent

Returns:

true if the target is this client

See Also:

annotation to filter only these events

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ActorMessageEventBase<A extends Actor>

Returns:

the partial toString generator