org.pircbotx.snapshot

Class ChannelSnapshot

java.lang.Object

org.pircbotx.Channel

org.pircbotx.snapshot.ChannelSnapshot

All Implemented Interfaces:

Comparable<Channel>

public class ChannelSnapshot
extends Channel

Author:

Leon Blakey

Constructor Summary

Constructors

Constructor and Description
ChannelSnapshot(Channel channel, String mode)

Method Summary

Modifier and Type	Method and Description
ChannelSnapshot	createSnapshot() Create an immutable snapshot of this channel.
Channel	getGeneratedFrom()
String	getMode() Gets the channel mode.
void	setDao(UserChannelDaoSnapshot dao)

Methods inherited from class org.pircbotx.Channel

compareTo, containsMode, equals, getBot, getChannelId, getChannelKey, getChannelLimit, getCreateTimestamp, getHalfOps, getName, getNormalUsers, getOps, getOwners, getSuperOps, getTopic, getTopicSetter, getTopicTimestamp, getUserLevels, getUsers, getUsersNicks, getVoices, hashCode, hasTopicProtection, hasVoice, isChannelPrivate, isHalfOp, isInviteOnly, isModerated, isNoExternalMessages, isOp, isOwner, isSecret, isSuperOp, send, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelSnapshot

public ChannelSnapshot(Channel channel,
                       String mode)

Method Detail

createSnapshot

public ChannelSnapshot createSnapshot()

Description copied from class: Channel

Create an immutable snapshot of this channel.

Overrides:

createSnapshot in class Channel

Returns:

Immutable Channel copy minus the DAO

setDao

@Generated(value="lombok")
public void setDao(UserChannelDaoSnapshot dao)

getGeneratedFrom

@Generated(value="lombok")
public Channel getGeneratedFrom()

getMode

@Generated(value="lombok")
public String getMode()

Description copied from class: Channel

Gets the channel mode. If mode is simple (no arguments), this will return immediately. If its not (mode with arguments, eg channel key), then asks the server for the correct mode, waiting until it gets a response

WARNING: Because of the last checking, a threaded listener manager like ThreadedListenerManager is required. Using a single threaded listener manager like GenericListenerManager will mean this method never returns!

Overrides:

getMode in class Channel

Returns:

A known good mode, either immediately or soon.