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

Class ActorEventBase<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>

Type Parameters:

A - actor involved

All Implemented Interfaces:

ClientLinked, ActorEvent<A>, ClientEvent, ServerMessageEvent

Direct Known Subclasses:

ActorChannelEventBase, ActorMessageEventBase, ClientReceiveServerMessageEventBase, UserAccountStatusEvent, UserAwayMessageEvent, UserInfoChangeEventBase, UserModeEvent

public abstract class ActorEventBase<A extends Actor>
extends ServerMessageEventBase
implements ActorEvent<A>

Abstract base class for events involving an Actor. Use the helper events if you want to listen to such events.

See Also:

ActorEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActorEventBase(Client client, List<ServerMessage> originalMessages, A actor) Constructs the event.

Method Summary

Modifier and Type	Method and Description
A	getActor() Gets the actor responsible for this event.
protected ToStringer	toStringer() Generates a partial ToStringer for the command.

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

getOriginalMessages

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

getOriginalMessages

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

getClient

Constructor Detail

ActorEventBase

protected ActorEventBase(@Nonnull
                         Client client,
                         @Nonnull
                         List<ServerMessage> originalMessages,
                         @Nonnull
                         A actor)

Constructs the event.

Parameters:

client - the client

originalMessages - original messages

actor - the actor

Method Detail

getActor

@Nonnull
public final A getActor()

Description copied from interface: ActorEvent

Gets the actor responsible for this event.

Specified by:

getActor in interface ActorEvent<A extends Actor>

Returns:

the actor

toStringer

@Nonnull
protected ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ServerMessageEventBase

Returns:

the partial toString generator