org.kitteh.irc.client.library.event.channel

Class ChannelJoinEvent

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<User>

org.kitteh.irc.client.library.event.channel.ChannelJoinEvent

All Implemented Interfaces:

ClientLinked, ActorEvent<User>, ChannelEvent, ChannelUserListChangeEvent, ClientEvent, ServerMessageEvent

Direct Known Subclasses:

RequestedChannelJoinCompleteEvent

public class ChannelJoinEvent
extends ActorChannelEventBase<User>
implements ChannelUserListChangeEvent

A User has joined a Channel!

Nested Class Summary

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.event.helper.ChannelUserListChangeEvent

ChannelUserListChangeEvent.Change

Constructor Summary

Constructors

Constructor and Description
ChannelJoinEvent(Client client, List<ServerMessage> originalMessages, Channel channel, User user) Creates the event.

Method Summary

Modifier and Type	Method and Description
Optional<Channel>	getAffectedChannel() Gets the channel affected or empty if affecting all channels the user is present in.
ChannelUserListChangeEvent.Change	getChange() Gets the type of change occurring.
User	getUser() Gets the current user affected.

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

getChannel, toStringer

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

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

ChannelJoinEvent

public ChannelJoinEvent(@Nonnull
                        Client client,
                        @Nonnull
                        List<ServerMessage> originalMessages,
                        @Nonnull
                        Channel channel,
                        @Nonnull
                        User user)

Creates the event.

Parameters:

client - client for which this is occurring

originalMessages - original messages

channel - the channel joined

user - the user joining

Method Detail

getAffectedChannel

@Nonnull
public Optional<Channel> getAffectedChannel()

Description copied from interface: ChannelUserListChangeEvent

Gets the channel affected or empty if affecting all channels the user is present in.

Specified by:

getAffectedChannel in interface ChannelUserListChangeEvent

Returns:

channel or empty if all channels affected

getChange

@Nonnull
public ChannelUserListChangeEvent.Change getChange()

Description copied from interface: ChannelUserListChangeEvent

Gets the type of change occurring.

Specified by:

getChange in interface ChannelUserListChangeEvent

Returns:

type of change

getUser

@Nonnull
public User getUser()

Description copied from interface: ChannelUserListChangeEvent

Gets the current user affected.

Specified by:

getUser in interface ChannelUserListChangeEvent

Returns:

user