org.kitteh.irc.client.library.defaults.feature

Class DefaultActorTracker

java.lang.Object

org.kitteh.irc.client.library.defaults.feature.DefaultActorTracker

All Implemented Interfaces:

ActorTracker, Resettable

public class DefaultActorTracker
extends Object
implements ActorTracker

Default implementation of ActorTracker.

Constructor Summary

Constructors

Constructor and Description
DefaultActorTracker(Client.WithManagement client) Constructs the tracker.

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	reset() Resets.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultActorTracker

public DefaultActorTracker(@Nonnull
                           Client.WithManagement client)

Constructs the tracker.

Parameters:

client - client

Method Detail

getActor

@Nonnull
public Actor getActor(@Nonnull
                                String name)

Description copied from interface: ActorTracker

Gets an Actor based on the name provided.

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

Specified by:

getActor in interface ActorTracker

Parameters:

name - name

Returns:

actor based on input

getTrackedChannel

@Nonnull
public Optional<Channel> getTrackedChannel(@Nonnull
                                                     String channel)

Description copied from interface: ActorTracker

Gets a tracked channel.

Specified by:

getTrackedChannel in interface ActorTracker

Parameters:

channel - channel name

Returns:

channel if tracked

getTrackedChannels

@Nonnull
public Set<Channel> getTrackedChannels()

Description copied from interface: ActorTracker

Gets all tracked channels.

Specified by:

getTrackedChannels in interface ActorTracker

Returns:

tracked channels

getTrackedUser

@Nonnull
public Optional<User> getTrackedUser(@Nonnull
                                               String nick)

Description copied from interface: ActorTracker

Gets a tracked user.

Specified by:

getTrackedUser in interface ActorTracker

Parameters:

nick - nickname of the user

Returns:

user if tracked

isStale

public boolean isStale(@Nonnull
                       Staleable staleable)

Description copied from interface: ActorTracker

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

Specified by:

isStale in interface ActorTracker

Parameters:

staleable - potentially stale object

Returns:

true if stale

setChannelListReceived

public void setChannelListReceived(@Nonnull
                                   String channel)

Description copied from interface: ActorTracker

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

Specified by:

setChannelListReceived in interface ActorTracker

Parameters:

channel - channel

setChannelModeInfoList

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

Description copied from interface: ActorTracker

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

Specified by:

setChannelModeInfoList in interface ActorTracker

Parameters:

channel - channel

mode - mode

modeInfo - mode info

setChannelTopic

public void setChannelTopic(@Nonnull
                            String channel,
                            @Nonnull
                            String topic)

Description copied from interface: ActorTracker

Sets a channel's topic.

Specified by:

setChannelTopic in interface ActorTracker

Parameters:

channel - channel

topic - topic

setChannelTopicInfo

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

Description copied from interface: ActorTracker

Sets info on a channel's topic.

Specified by:

setChannelTopicInfo in interface ActorTracker

Parameters:

channel - channel

time - topic set time

actor - topic setter

setQueryChannelInformation

public void setQueryChannelInformation(boolean query)

Description copied from interface: ActorTracker

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

Specified by:

setQueryChannelInformation in interface ActorTracker

Parameters:

query - true to query, false to not

setUserAccount

public void setUserAccount(@Nonnull
                           String nick,
                           @Nullable
                           String account)

Description copied from interface: ActorTracker

Sets the account for a tracked user.

Specified by:

setUserAccount in interface ActorTracker

Parameters:

nick - nick

account - account or null if signed out

setUserAway

public void setUserAway(@Nonnull
                        String nick,
                        @Nullable
                        String message)

Description copied from interface: ActorTracker

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

Specified by:

setUserAway in interface ActorTracker

Parameters:

nick - nick

message - away message or null for not away

setUserAway

public void setUserAway(@Nonnull
                        String nick,
                        boolean away)

Description copied from interface: ActorTracker

Sets a user as away without knowing the away message.

Specified by:

setUserAway in interface ActorTracker

Parameters:

nick - nick

away - true for away, false for not away

setUserOperString

public void setUserOperString(@Nonnull
                              String nick,
                              @Nonnull
                              String operString)

Description copied from interface: ActorTracker

Sets OPER information known about a user.

Specified by:

setUserOperString in interface ActorTracker

Parameters:

nick - nick

operString - oper info

setUserRealName

public void setUserRealName(@Nonnull
                            String nick,
                            @Nonnull
                            String realName)

Description copied from interface: ActorTracker

Sets the real name of the user.

Specified by:

setUserRealName in interface ActorTracker

Parameters:

nick - nick

realName - real name

setUserServer

public void setUserServer(@Nonnull
                          String nick,
                          @Nonnull
                          String server)

Description copied from interface: ActorTracker

Sets the server of a user.

Specified by:

setUserServer in interface ActorTracker

Parameters:

nick - nick

server - server

shouldQueryChannelInformation

public boolean shouldQueryChannelInformation()

Description copied from interface: ActorTracker

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

Specified by:

shouldQueryChannelInformation in interface ActorTracker

Returns:

true if set to query automatically

trackChannel

public void trackChannel(@Nonnull
                         String channel)

Description copied from interface: ActorTracker

Tracks a channel.

Specified by:

trackChannel in interface ActorTracker

Parameters:

channel - channel to track

trackChannelMode

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

Description copied from interface: ActorTracker

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

Specified by:

trackChannelMode in interface ActorTracker

Parameters:

channel - channel

mode - mode to track

track - true to track false to stop tracking

trackChannelModeInfo

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

Description copied from interface: ActorTracker

Tracks mode info.

Specified by:

trackChannelModeInfo in interface ActorTracker

Parameters:

channel - channel

add - true to add false to remove

modeInfo - info

trackChannelNick

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

Description copied from interface: ActorTracker

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

Specified by:

trackChannelNick in interface ActorTracker

Parameters:

channel - channel

nick - nick

modes - modes on the user

trackChannelUser

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

Description copied from interface: ActorTracker

Tracks a user.

Specified by:

trackChannelUser in interface ActorTracker

Parameters:

channel - channel

user - user

modes - modes on user

trackUser

public void trackUser(@Nonnull
                      User user)

Description copied from interface: ActorTracker

Tracks a user.

Specified by:

trackUser in interface ActorTracker

Parameters:

user - user to track

trackUserHostnameChange

public void trackUserHostnameChange(@Nonnull
                                    String nick,
                                    @Nonnull
                                    String newHostname)

Description copied from interface: ActorTracker

Tracks a user's hostname changing.

Specified by:

trackUserHostnameChange in interface ActorTracker

Parameters:

nick - nick

newHostname - new hostname

trackUserNickChange

public void trackUserNickChange(@Nonnull
                                String oldNick,
                                @Nonnull
                                String newNick)

Description copied from interface: ActorTracker

Tracks a user's nick change.

Specified by:

trackUserNickChange in interface ActorTracker

Parameters:

oldNick - old nick

newNick - new nick

trackUserPart

public void trackUserPart(@Nonnull
                          String channel,
                          @Nonnull
                          String nick)

Description copied from interface: ActorTracker

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

Specified by:

trackUserPart in interface ActorTracker

Parameters:

channel - channel

nick - nick parting

trackUserQuit

public void trackUserQuit(@Nonnull
                          String nick)

Description copied from interface: ActorTracker

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

Specified by:

trackUserQuit in interface ActorTracker

Parameters:

nick - nick quitting

trackUserUserStringChange

public void trackUserUserStringChange(@Nonnull
                                      String nick,
                                      @Nonnull
                                      String newUserString)

Description copied from interface: ActorTracker

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

Specified by:

trackUserUserStringChange in interface ActorTracker

Parameters:

nick - nick

newUserString - new user string

unTrackChannel

public void unTrackChannel(@Nonnull
                           String channel)

Description copied from interface: ActorTracker

Stops tracking a channel.

Specified by:

unTrackChannel in interface ActorTracker

Parameters:

channel - channel to untrack

updateChannelModes

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

Description copied from interface: ActorTracker

Updates status modes.

Specified by:

updateChannelModes in interface ActorTracker

Parameters:

channel - channel

statusList - mode status list

reset

public void reset()

Description copied from interface: Resettable

Resets.

Specified by:

reset in interface Resettable