org.kitteh.irc.client.library.feature

Interface ActorTracker

All Superinterfaces:

Resettable

All Known Implementing Classes:

DefaultActorTracker

public interface ActorTracker
extends Resettable

Tracker of users and channels, provider of all actors.

Method Summary

Modifier and Type	Method and Description
@NonNull Actor	getActor(@NonNull String name) Gets an Actor based on the name provided.
@NonNull Optional<Channel>	getChannel(@NonNull String channel) Gets a channel.
@NonNull Optional<Channel>	getTrackedChannel(@NonNull String channel) Gets a tracked channel.
@NonNull Set<Channel>	getTrackedChannels() Gets all tracked channels.
@NonNull Optional<User>	getTrackedUser(@NonNull String nick) Gets a tracked user.
boolean	isStale(@NonNull Staleable staleable) Gets if the given staleable object is considered stale by the tracker.
void	setChannelListReceived(@NonNull String channel) Sets a channel is having had the full user list received.
void	setChannelModeInfoList(@NonNull String channel, char mode, List<ModeInfo> modeInfo) Sets a channel's mode info list for a given mode, such as bans.
void	setChannelTopic(@NonNull String channel, @NonNull String topic) Sets a channel's topic.
void	setChannelTopicInfo(@NonNull String channel, long time, @NonNull Actor actor) Sets info on a channel's topic.
void	setQueryChannelInformation(boolean query) Sets if channel information should be queried (WHO, MODE) automatically on join.
void	setUserAccount(@NonNull String nick, @Nullable String account) Sets the account for a tracked user.
void	setUserAway(@NonNull String nick, boolean away) Sets a user as away without knowing the away message.
void	setUserAway(@NonNull String nick, @Nullable String message) Sets a user away message, setting them to be recorded as away.
void	setUserOperString(@NonNull String nick, @NonNull String operString) Sets OPER information known about a user.
void	setUserRealName(@NonNull String nick, @NonNull String realName) Sets the real name of the user.
void	setUserServer(@NonNull String nick, @NonNull String server) Sets the server of a user.
boolean	shouldQueryChannelInformation() Gets if channel information should be queried (WHO, MODE) automatically on join.
void	trackChannel(@NonNull String channel) Tracks a channel.
void	trackChannelMode(@NonNull String channel, @NonNull ChannelMode mode, boolean track) Sets tracking status of a mode (such as bans).
void	trackChannelModeInfo(@NonNull String channel, boolean add, @NonNull ModeInfo modeInfo) Tracks mode info.
void	trackChannelNick(@NonNull String channel, @NonNull String nick, @NonNull Set<ChannelUserMode> modes) Tracks a user based on likely nickname input.
void	trackChannelUser(@NonNull String channel, @NonNull User user, @NonNull Set<ChannelUserMode> modes) Tracks a user.
void	trackUser(@NonNull User user) Tracks a user.
void	trackUserHostnameChange(@NonNull String nick, @NonNull String newHostname) Tracks a user's hostname changing.
void	trackUserNickChange(@NonNull String oldNick, @NonNull String newNick) Tracks a user's nick change.
void	trackUserPart(@NonNull String channel, @NonNull String nick) Tracks a user parting a channel, potentially untracking them overall if they are no longer in any tracked channel.
void	trackUserQuit(@NonNull String nick) Tracks a user quitting, removing them from all channels in which they were tracked.
void	trackUserRealnameChange(@NonNull String nick, @NonNull String newRealname) Tracks a user's realname changing.
void	trackUserUserStringChange(@NonNull String nick, @NonNull String newUserString) Tracks a users's user string (ident) changing.
void	unTrackChannel(@NonNull String channel) Stops tracking a channel.
void	updateChannelModes(@NonNull String channel, @NonNull ModeStatusList<ChannelMode> statusList) Updates status modes.

Methods inherited from interface org.kitteh.irc.client.library.util.Resettable

reset

Method Detail

getActor

@NonNull Actor getActor(@NonNull String name)

Gets an Actor based on the name provided.

For User the name needs the full mask and for channels the name needs the prefix.

Parameters:

name - name

Returns:

actor based on input

getChannel

@NonNull Optional<Channel> getChannel(@NonNull String channel)

Gets a channel.

Parameters:

channel - channel name

Returns:

channel if a valid channel name

getTrackedChannel

@NonNull Optional<Channel> getTrackedChannel(@NonNull String channel)

Gets a tracked channel.

Parameters:

channel - channel name

Returns:

channel if tracked

getTrackedChannels

@NonNull Set<Channel> getTrackedChannels()

Gets all tracked channels.

Returns:

tracked channels

getTrackedUser

@NonNull Optional<User> getTrackedUser(@NonNull String nick)

Gets a tracked user.

Parameters:

nick - nickname of the user

Returns:

user if tracked

isStale

boolean isStale(@NonNull Staleable staleable)

Gets if the given staleable object is considered stale by the tracker.

Parameters:

staleable - potentially stale object

Returns:

true if stale

setChannelListReceived

void setChannelListReceived(@NonNull String channel)

Sets a channel is having had the full user list received.

Parameters:

channel - channel

setChannelModeInfoList

void setChannelModeInfoList(@NonNull String channel,
                            char mode,
                            List<ModeInfo> modeInfo)

Sets a channel's mode info list for a given mode, such as bans.

Parameters:

channel - channel

mode - mode

modeInfo - mode info

setChannelTopic

void setChannelTopic(@NonNull String channel,
                     @NonNull String topic)

Sets a channel's topic.

Parameters:

channel - channel

topic - topic

setChannelTopicInfo

void setChannelTopicInfo(@NonNull String channel,
                         long time,
                         @NonNull Actor actor)

Sets info on a channel's topic.

Parameters:

channel - channel

time - topic set time

actor - topic setter

setQueryChannelInformation

void setQueryChannelInformation(boolean query)

Sets if channel information should be queried (WHO, MODE) automatically on join. Defaults to true.

Parameters:

query - true to query, false to not

setUserAccount

void setUserAccount(@NonNull String nick,
                    @Nullable String account)

Sets the account for a tracked user.

Parameters:

nick - nick

account - account or null if signed out

setUserAway

void setUserAway(@NonNull String nick,
                 @Nullable String message)

Sets a user away message, setting them to be recorded as away.

Parameters:

nick - nick

message - away message or null for not away

setUserAway

void setUserAway(@NonNull String nick,
                 boolean away)

Sets a user as away without knowing the away message.

Parameters:

nick - nick

away - true for away, false for not away

setUserOperString

void setUserOperString(@NonNull String nick,
                       @NonNull String operString)

Sets OPER information known about a user.

Parameters:

nick - nick

operString - oper info

setUserRealName

void setUserRealName(@NonNull String nick,
                     @NonNull String realName)

Sets the real name of the user.

Parameters:

nick - nick

realName - real name

setUserServer

void setUserServer(@NonNull String nick,
                   @NonNull String server)

Sets the server of a user.

Parameters:

nick - nick

server - server

shouldQueryChannelInformation

boolean shouldQueryChannelInformation()

Gets if channel information should be queried (WHO, MODE) automatically on join.

Returns:

true if set to query automatically

trackChannel

void trackChannel(@NonNull String channel)

Tracks a channel.

Parameters:

channel - channel to track

trackChannelMode

void trackChannelMode(@NonNull String channel,
                      @NonNull ChannelMode mode,
                      boolean track)

Sets tracking status of a mode (such as bans).

Parameters:

channel - channel

mode - mode to track

track - true to track false to stop tracking

trackChannelModeInfo

void trackChannelModeInfo(@NonNull String channel,
                          boolean add,
                          @NonNull ModeInfo modeInfo)

Tracks mode info.

Parameters:

channel - channel

add - true to add false to remove

modeInfo - info

trackChannelNick

void trackChannelNick(@NonNull String channel,
                      @NonNull String nick,
                      @NonNull Set<ChannelUserMode> modes)

Tracks a user based on likely nickname input. Will process as full name mask if that is provided instead.

Parameters:

channel - channel

nick - nick

modes - modes on the user

trackChannelUser

void trackChannelUser(@NonNull String channel,
                      @NonNull User user,
                      @NonNull Set<ChannelUserMode> modes)

Tracks a user.

Parameters:

channel - channel

user - user

modes - modes on user

trackUser

void trackUser(@NonNull User user)

Tracks a user.

Parameters:

user - user to track

trackUserHostnameChange

void trackUserHostnameChange(@NonNull String nick,
                             @NonNull String newHostname)

Tracks a user's hostname changing.

Parameters:

nick - nick

newHostname - new hostname

trackUserNickChange

void trackUserNickChange(@NonNull String oldNick,
                         @NonNull String newNick)

Tracks a user's nick change.

Parameters:

oldNick - old nick

newNick - new nick

trackUserRealnameChange

void trackUserRealnameChange(@NonNull String nick,
                             @NonNull String newRealname)

Tracks a user's realname changing.

Parameters:

nick - nick

newRealname - new realname

trackUserPart

void trackUserPart(@NonNull String channel,
                   @NonNull String nick)

Tracks a user parting a channel, potentially untracking them overall if they are no longer in any tracked channel.

Parameters:

channel - channel

nick - nick parting

trackUserQuit

void trackUserQuit(@NonNull String nick)

Tracks a user quitting, removing them from all channels in which they were tracked.

Parameters:

nick - nick quitting

trackUserUserStringChange

void trackUserUserStringChange(@NonNull String nick,
                               @NonNull String newUserString)

Tracks a users's user string (ident) changing.

Parameters:

nick - nick

newUserString - new user string

unTrackChannel

void unTrackChannel(@NonNull String channel)

Stops tracking a channel.

Parameters:

channel - channel to untrack

updateChannelModes

void updateChannelModes(@NonNull String channel,
                        @NonNull ModeStatusList<ChannelMode> statusList)

Updates status modes.

Parameters:

channel - channel

statusList - mode status list