org.pircbotx.snapshot

Class UserChannelDaoSnapshot

java.lang.Object

org.pircbotx.UserChannelDao<UserSnapshot,ChannelSnapshot>

org.pircbotx.snapshot.UserChannelDaoSnapshot

All Implemented Interfaces:

Closeable, AutoCloseable

public class UserChannelDaoSnapshot
extends UserChannelDao<UserSnapshot,ChannelSnapshot>

Author:

Leon Blakey

Constructor Summary

Constructors

Constructor and Description
UserChannelDaoSnapshot(PircBotX bot, Locale locale, UserChannelMapSnapshot mainMap, EnumMap<UserLevel,UserChannelMap<UserSnapshot,ChannelSnapshot>> levelsMap, com.google.common.collect.ImmutableMap<String,UserSnapshot> userNickMap, com.google.common.collect.ImmutableMap<String,ChannelSnapshot> channelNameMap, com.google.common.collect.ImmutableMap<String,UserSnapshot> privateUsers)

Method Summary

Modifier and Type	Method and Description
void	close() Clears all internal maps
ChannelSnapshot	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.
UserSnapshot	createUser(UserHostmask userHostmask) Create a user from a hostmask, internally called when a valid, real user contacts us
UserSnapshot	getUserBot() Gets the bots own user object.

Methods inherited from class org.pircbotx.UserChannelDao

channelExists, containsChannel, containsUser, containsUser, getAllChannels, getAllUsers, getChannel, getChannels, getChannels, getLevels, getNormalUserChannels, getNormalUsers, getUser, getUser, getUsers, getUsers, userExists

Methods inherited from class java.lang.Object

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

Constructor Detail

UserChannelDaoSnapshot

public UserChannelDaoSnapshot(PircBotX bot,
                              Locale locale,
                              UserChannelMapSnapshot mainMap,
                              EnumMap<UserLevel,UserChannelMap<UserSnapshot,ChannelSnapshot>> levelsMap,
                              com.google.common.collect.ImmutableMap<String,UserSnapshot> userNickMap,
                              com.google.common.collect.ImmutableMap<String,ChannelSnapshot> channelNameMap,
                              com.google.common.collect.ImmutableMap<String,UserSnapshot> privateUsers)

Method Detail

createSnapshot

public UserChannelDaoSnapshot createSnapshot()

Description copied from class: UserChannelDao

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

Overrides:

createSnapshot in class UserChannelDao<UserSnapshot,ChannelSnapshot>

Returns:

Copy of entire model

createChannel

public ChannelSnapshot createChannel(String name)

Description copied from class: UserChannelDao

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

Overrides:

createChannel in class UserChannelDao<UserSnapshot,ChannelSnapshot>

createUser

public UserSnapshot createUser(UserHostmask userHostmask)

Description copied from class: UserChannelDao

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

Overrides:

createUser in class UserChannelDao<UserSnapshot,ChannelSnapshot>

Parameters:

userHostmask - The hostmask of the user

Returns:

Active User that was created

getUserBot

public UserSnapshot getUserBot()

Description copied from class: UserChannelDao

Gets the bots own user object.

Overrides:

getUserBot in class UserChannelDao<UserSnapshot,ChannelSnapshot>

Returns:

The user object representing this bot

close

public void close()

Description copied from class: UserChannelDao

Clears all internal maps

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class UserChannelDao<UserSnapshot,ChannelSnapshot>