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

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

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