org.pircbotx

Class UserChannelDao<U extends User,C extends Channel>

java.lang.Object

org.pircbotx.UserChannelDao<U,C>

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

UserChannelDaoSnapshot

public class UserChannelDao<U extends User,C extends Channel>
extends Object
implements Closeable

Model that creates and tracks Users and Channel and maintains relationships. This includes channel users, channel op/voice/etc users, private messages, etc

All methods will throw a NullPointerException when any argument is null

Author:

Leon Blakey

See Also:

User, Channel

Method Summary

Modifier and Type	Method and Description
boolean	channelExists(String name) Deprecated. Renamed containsChannel(java.lang.String) to match the Java Collections API
void	close() Clears all internal maps
boolean	containsChannel(String name) Check if we are currently in the given channel
boolean	containsUser(String nick) Check if user exists by nick
boolean	containsUser(UserHostmask hostmask) Check if user exists by hostmask
C	createChannel(String name) Creates a known channel, internally called when we join a channel
UserChannelDaoSnapshot	createSnapshot() Create an immutable snapshot (copy) of all of contained Users, Channels, and mappings, VERY EXPENSIVE.
U	createUser(UserHostmask userHostmask) Create a user from a hostmask, internally called when a valid, real user contacts us
com.google.common.collect.ImmutableSortedSet<C>	getAllChannels() Get all currently joined channels
com.google.common.collect.ImmutableSortedSet<U>	getAllUsers() Get all currently known users, except from just joined channels where the WHO response hasn't finished (listen for UserListEvent instead)
C	getChannel(String name) Lookup channel by name, throwing a DaoException if not found
com.google.common.collect.ImmutableSortedSet<C>	getChannels(U user) Get channels we're joined to that the user is joined to as well
com.google.common.collect.ImmutableSortedSet<C>	getChannels(U user, UserLevel level) Gets all currently known channels the user is a part of with the specified level.
com.google.common.collect.ImmutableSortedSet<UserLevel>	getLevels(C channel, U user) Gets all currently known levels (op/voice/etc) a user holds in the channel.
com.google.common.collect.ImmutableSortedSet<C>	getNormalUserChannels(U user) Gets all currently known channels the user is a part of as a normal user.
com.google.common.collect.ImmutableSortedSet<U>	getNormalUsers(C channel) Gets all currently known users in a channel who do not hold a UserLevel (op/voice/etc).
U	getUser(String nick) Lookup user by nick, throwing a DaoException if not found
U	getUser(UserHostmask userHostmask) Lookup user by UserHostmask, throwing a DaoException if not found
User	getUserBot() Gets the bots own user object.
com.google.common.collect.ImmutableSortedSet<U>	getUsers(C channel) Get all currently known users in a channel
com.google.common.collect.ImmutableSortedSet<U>	getUsers(C channel, UserLevel level) Gets all currently known users in a channel that hold the specified UserLevel.
boolean	userExists(String nick) Deprecated. Renamed containsUser(java.lang.String) to match Java Collections API

Methods inherited from class java.lang.Object

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

Method Detail

getUser

public U getUser(@NonNull
                 String nick)
          throws DaoException

Lookup user by nick, throwing a DaoException if not found

Parameters:

nick - The nick of the user

Returns:

Known active User

Throws:

DaoException - If user does not exist, exception will contain DaoException.Reason.UNKNOWN_USER and the nick that doesn't exist

getUser

public U getUser(@NonNull
                 UserHostmask userHostmask)

Lookup user by UserHostmask, throwing a DaoException if not found

Parameters:

userHostmask - The hostmask of the user

Returns:

Known active User

Throws:

DaoException - If user does not exist, exception will contain DaoException.Reason.UNKNOWN_USER_HOSTMASK, hostmask, and wrapped exception with nick

createUser

public U createUser(@NonNull
                    UserHostmask userHostmask)

Create a user from a hostmask, internally called when a valid, real user contacts us

Parameters:

userHostmask - The hostmask of the user

Returns:

Active User that was created

userExists

@Deprecated
public boolean userExists(@NonNull
                                      String nick)

Deprecated. Renamed containsUser(java.lang.String) to match Java Collections API

See Also:

containsUser(java.lang.String)

containsUser

public boolean containsUser(@NonNull
                            String nick)

Check if user exists by nick

Parameters:

nick - Nick of user

Returns:

True if user exists

containsUser

public boolean containsUser(@NonNull
                            UserHostmask hostmask)

Check if user exists by hostmask

Parameters:

hostmask - Hostmask of user

Returns:

True if user exists

getAllUsers

public com.google.common.collect.ImmutableSortedSet<U> getAllUsers()

Get all currently known users, except from just joined channels where the WHO response hasn't finished (listen for UserListEvent instead)

Returns:

An immutable set of the currently known users

See Also:

UserListEvent

getNormalUsers

public com.google.common.collect.ImmutableSortedSet<U> getNormalUsers(@NonNull
                                                                      C channel)

Gets all currently known users in a channel who do not hold a UserLevel (op/voice/etc). A UserListEvent for the channel must of been dispatched before this method will return complete results

Parameters:

channel - Known channel

Returns:

An immutable sorted set of Users

getUsers

public com.google.common.collect.ImmutableSortedSet<U> getUsers(@NonNull
                                                                C channel,
                                                                @NonNull
                                                                UserLevel level)

Gets all currently known users in a channel that hold the specified UserLevel. A UserListEvent for the channel must of been dispatched before this method will return complete results

Parameters:

channel - Known channel

level - Level users must hold

Returns:

An immutable sorted set of Users

getLevels

public com.google.common.collect.ImmutableSortedSet<UserLevel> getLevels(@NonNull
                                                                         C channel,
                                                                         @NonNull
                                                                         U user)

Gets all currently known levels (op/voice/etc) a user holds in the channel. A UserListEvent for the channel must of been dispatched before this method will return complete results

Parameters:

channel - Known channel

user - Known user

Returns:

An immutable sorted set of UserLevels

getNormalUserChannels

public com.google.common.collect.ImmutableSortedSet<C> getNormalUserChannels(@NonNull
                                                                             U user)

Gets all currently known channels the user is a part of as a normal user. A UserListEvent for all channels must of been dispatched before this method will return complete results

Parameters:

user - Known user

Returns:

An immutable sorted set of Channels

getChannels

public com.google.common.collect.ImmutableSortedSet<C> getChannels(@NonNull
                                                                   U user,
                                                                   @NonNull
                                                                   UserLevel level)

Gets all currently known channels the user is a part of with the specified level. A UserListEvent for all channels must of been dispatched before this method will return complete results

Parameters:

user - Known user

Returns:

An immutable sorted set of Channels

getChannel

public C getChannel(@NonNull
                    String name)
             throws DaoException

Lookup channel by name, throwing a DaoException if not found

Parameters:

name - Name of channel (eg #pircbotx)

Returns:

A known channel

Throws:

DaoException

createChannel

public C createChannel(@NonNull
                       String name)

Creates a known channel, internally called when we join a channel

Parameters:

name -

channelExists

@Deprecated
public boolean channelExists(@NonNull
                                         String name)

Deprecated. Renamed containsChannel(java.lang.String) to match the Java Collections API

See Also:

containsChannel(java.lang.String)

containsChannel

public boolean containsChannel(@NonNull
                               String name)

Check if we are currently in the given channel

Parameters:

name - Channel name (eg #pircbotx)

Returns:

True if we are still connected to the channel

getUsers

public com.google.common.collect.ImmutableSortedSet<U> getUsers(@NonNull
                                                                C channel)

Get all currently known users in a channel

Parameters:

channel - Known channel

Returns:

An immutable set of users

getAllChannels

public com.google.common.collect.ImmutableSortedSet<C> getAllChannels()

Get all currently joined channels

Returns:

An immutable set of channels

getChannels

public com.google.common.collect.ImmutableSortedSet<C> getChannels(@NonNull
                                                                   U user)

Get channels we're joined to that the user is joined to as well

Parameters:

user - A known user

Returns:

An immutable set of channels

getUserBot

public User getUserBot()

Gets the bots own user object.

Returns:

The user object representing this bot

close

public void close()

Clears all internal maps

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

createSnapshot

public UserChannelDaoSnapshot createSnapshot()

Create an immutable snapshot (copy) of all of contained Users, Channels, and mappings, VERY EXPENSIVE.

Returns:

Copy of entire model