org.kitteh.irc.client.library.defaults.element

Class DefaultChannel

java.lang.Object

org.kitteh.irc.client.library.defaults.element.DefaultActor

org.kitteh.irc.client.library.defaults.element.DefaultStaleable

org.kitteh.irc.client.library.defaults.element.DefaultChannel

All Implemented Interfaces:

Actor, Channel, ClientLinked, MessageReceiver, Snapshot, Staleable

public class DefaultChannel
extends DefaultStaleable
implements Channel

Default Channel implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultChannel.DefaultChannelCommands Default channel commands.

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.element.Channel

Channel.Commands, Channel.Topic

Constructor Summary

Constructors

Constructor and Description

DefaultChannel(Client.WithManagement client, @NonNull String name, @NonNull Channel.Topic topic, @NonNull ModeStatusList<ChannelMode> channelModes, @NonNull Map<Character,List<ModeInfo>> modeInfoLists, @NonNull Map<String,SortedSet<ChannelUserMode>> modes, @NonNull List<String> names, @NonNull Map<String,User> nickMap, @NonNull List<User> users, boolean complete, @NonNull DefaultChannel.DefaultChannelCommands commands) Constructs the channel snapshot.

Method Summary

Modifier and Type	Method and Description
@NonNull Channel.Commands	commands() Provides access to Commands.
boolean	equals(Object o)
@NonNull String	getMessagingName() Gets the name used when sending messages.
@NonNull Optional<List<ModeInfo>>	getModeInfoList(@NonNull ChannelMode mode) Gets the tracked mode info for the channel, if tracked.
@NonNull ModeStatusList<ChannelMode>	getModes() Gets the channel's current known modes.
@NonNull List<String>	getNicknames() Gets the nicknames of users in the channel, if the client is in the channel.
@NonNull Channel.Topic	getTopic() Gets the channel's topic.
@NonNull Optional<User>	getUser(@NonNull String nick) Gets a user by their nick, if they are known to the client.
@NonNull Optional<SortedSet<ChannelUserMode>>	getUserModes(@NonNull String nick) Gets the user modes of a given nickname in the channel.
@NonNull List<User>	getUsers() Gets all Users known to be in the channel.
boolean	hasCompleteUserData() Gets if this Channel has complete user data available, only possible if the Client is in the channel and the WHO list has sent.
int	hashCode()
void	setModeInfoTracking(@NonNull ChannelMode mode, boolean track) Sets whether a particular type A mode should be tracked for this channel, and sends a request for the full list.
@NonNull String	toString()

Methods inherited from class org.kitteh.irc.client.library.defaults.element.DefaultStaleable

isStale

Methods inherited from class org.kitteh.irc.client.library.defaults.element.DefaultActor

getClient, getCreationTime, getName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getLatest, getUserModes, join, join, kick, kick, part, part, setTopic

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

getLowerCaseMessagingName, sendCtcpMessage, sendMessage, sendMultiLineMessage, sendMultiLineMessage, sendMultiLineNotice, sendMultiLineNotice, sendNotice

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

getLowerCaseName, getName

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

getCreationTime

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

getClient

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

isStale

Constructor Detail

DefaultChannel

public DefaultChannel(Client.WithManagement client,
                      @NonNull String name,
                      @NonNull Channel.Topic topic,
                      @NonNull ModeStatusList<ChannelMode> channelModes,
                      @NonNull Map<Character,List<ModeInfo>> modeInfoLists,
                      @NonNull Map<String,SortedSet<ChannelUserMode>> modes,
                      @NonNull List<String> names,
                      @NonNull Map<String,User> nickMap,
                      @NonNull List<User> users,
                      boolean complete,
                      @NonNull DefaultChannel.DefaultChannelCommands commands)

Constructs the channel snapshot.

Parameters:

client - client

name - channel name

topic - topic

channelModes - channel modes

modeInfoLists - modeinfolists

modes - modes

names - who is in the channel

nickMap - map of nicks to Users

users - users

complete - true if WHO completed

commands - commands object

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getMessagingName

public @NonNull String getMessagingName()

Description copied from interface: MessageReceiver

Gets the name used when sending messages.

Specified by:

getMessagingName in interface MessageReceiver

Returns:

the name by which you can message this receiver

getModeInfoList

public @NonNull Optional<List<ModeInfo>> getModeInfoList(@NonNull ChannelMode mode)

Description copied from interface: Channel

Gets the tracked mode info for the channel, if tracked.

Specified by:

getModeInfoList in interface Channel

Parameters:

mode - type A mode to acquire

Returns:

list of mode info if tracked, empty if not tracked

getModes

public @NonNull ModeStatusList<ChannelMode> getModes()

Description copied from interface: Channel

Gets the channel's current known modes.

Specified by:

getModes in interface Channel

Returns:

known modes

getNicknames

public @NonNull List<String> getNicknames()

Description copied from interface: Channel

Gets the nicknames of users in the channel, if the client is in the channel.

Specified by:

getNicknames in interface Channel

Returns:

nicks in the channel

getTopic

public @NonNull Channel.Topic getTopic()

Description copied from interface: Channel

Gets the channel's topic.

Specified by:

getTopic in interface Channel

Returns:

channel topic

getUser

public @NonNull Optional<User> getUser(@NonNull String nick)

Description copied from interface: Channel

Gets a user by their nick, if they are known to the client. Note that the server may not have sent the User data over, while the nickname may be known to the channel.

Specified by:

getUser in interface Channel

Parameters:

nick - user's nick

Returns:

the user object, if known

See Also:

Channel.hasCompleteUserData(), ChannelUsersUpdatedEvent

getUserModes

public @NonNull Optional<SortedSet<ChannelUserMode>> getUserModes(@NonNull String nick)

Description copied from interface: Channel

Gets the user modes of a given nickname in the channel.

Specified by:

getUserModes in interface Channel

Parameters:

nick - user's nick

Returns:

a set of modes the user is known to have, if the user is known

getUsers

public @NonNull List<User> getUsers()

Description copied from interface: Channel

Gets all Users known to be in the channel. Note that the server may not have sent all User data over, while the nickname may be known to the channel. If you just want a list of nicknames, see Channel.getNicknames().

Specified by:

getUsers in interface Channel

Returns:

users in the channel

See Also:

Channel.hasCompleteUserData(), ChannelUsersUpdatedEvent

hasCompleteUserData

public boolean hasCompleteUserData()

Description copied from interface: Channel

Gets if this Channel has complete user data available, only possible if the Client is in the channel and the WHO list has sent.

Specified by:

hasCompleteUserData in interface Channel

Returns:

true if Client is in channel and WHO has finished

See Also:

ChannelUsersUpdatedEvent

setModeInfoTracking

public void setModeInfoTracking(@NonNull ChannelMode mode,
                                boolean track)

Description copied from interface: Channel

Sets whether a particular type A mode should be tracked for this channel, and sends a request for the full list. Currently supports modes b, e, I, and q. The best time to request this would be in RequestedChannelJoinCompleteEvent to ensure it's always set.

Specified by:

setModeInfoTracking in interface Channel

Parameters:

mode - mode to track

track - true to track, false to stop tracking

See Also:

ChannelModeInfoListEvent

commands

public @NonNull Channel.Commands commands()

Description copied from interface: Channel

Provides access to Commands.

Specified by:

commands in interface Channel

Returns:

commands

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public @NonNull String toString()

Overrides:

toString in class DefaultActor