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

Class TargetedUserChannelMessageEventBase

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.ActorChannelEventBase<A>

org.kitteh.irc.client.library.event.abstractbase.ActorChannelMessageEventBase<User>

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

All Implemented Interfaces:

ClientLinked, ActorEvent<User>, ChannelEvent, ChannelTargetedEvent, ClientEvent, MessageEvent, ServerMessageEvent

Direct Known Subclasses:

ChannelTargetedCtcpEvent, ChannelTargetedMessageEvent, ChannelTargetedNoticeEvent

public abstract class TargetedUserChannelMessageEventBase
extends ActorChannelMessageEventBase<User>
implements ChannelTargetedEvent, MessageEvent

Abstract base class for events involving an Actor and Channel and have a message while being targeted at a specific subset of users to that Channel. Use the helper events if you want to listen to events involving either.

See Also:

ActorEvent, ChannelEvent, MessageEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TargetedUserChannelMessageEventBase(@NonNull Client client, @NonNull ServerMessage sourceMessage, @NonNull User user, @NonNull Channel channel, @NonNull ChannelUserMode prefix, @NonNull String message) Constructs the event.

Method Summary

Modifier and Type	Method and Description
@NonNull ChannelUserMode	getPrefix() Gets the prefix to which the message was sent.
protected @NonNull ToStringer	toStringer() Generates a partial ToStringer for the command.

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

getMessage

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

getChannel

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.ChannelTargetedEvent

getTargetedName

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

getChannel

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

getMessage

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

TargetedUserChannelMessageEventBase

protected TargetedUserChannelMessageEventBase(@NonNull Client client,
                                              @NonNull ServerMessage sourceMessage,
                                              @NonNull User user,
                                              @NonNull Channel channel,
                                              @NonNull ChannelUserMode prefix,
                                              @NonNull String message)

Constructs the event.

Parameters:

client - the client

sourceMessage - source message

user - the user

channel - the channel

prefix - the targeted prefix

message - the message

Method Detail

getPrefix

public final @NonNull ChannelUserMode getPrefix()

Description copied from interface: ChannelTargetedEvent

Gets the prefix to which the message was sent.

Specified by:

getPrefix in interface ChannelTargetedEvent

Returns:

the prefix targeted

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ActorChannelMessageEventBase<User>

Returns:

the partial toString generator