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

Class PrivateEventBase<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.PrivateEventBase<A>

Type Parameters:

A - actor involved

All Implemented Interfaces:

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

Direct Known Subclasses:

PrivateTagMessageEvent

public class PrivateEventBase<A extends Actor>
extends ActorEventBase<A>
implements PrivateEvent

Abstract base class for events involving a target.

Constructor Summary

Constructors

Constructor and Description
PrivateEventBase(@NonNull Client client, @NonNull ServerMessage sourceMessage, A sender, @NonNull String target) Creates 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.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.element.ClientLinked

getClient

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

getTag, getTag, getTags

Constructor Detail

PrivateEventBase

public PrivateEventBase(@NonNull Client client,
                        @NonNull ServerMessage sourceMessage,
                        A sender,
                        @NonNull String target)

Creates the event.

Parameters:

client - client for which this is occurring

sourceMessage - source message

sender - who sent it

target - who received it

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 ActorEventBase<A extends Actor>

Returns:

the partial toString generator