org.kitteh.irc.client.library.event.channel

Class ChannelTopicEvent

java.lang.Object

org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

org.kitteh.irc.client.library.event.abstractbase.ChannelEventBase

org.kitteh.irc.client.library.event.channel.ChannelTopicEvent

All Implemented Interfaces:

ClientLinked, ChannelEvent, ClientEvent, ServerMessageEvent

public class ChannelTopicEvent
extends ChannelEventBase

The server has informed us of a channel's topic.

Either the topic has changed or we requested to know what the topic was.

Constructor Summary

Constructors

Constructor and Description
ChannelTopicEvent(@NonNull Client client, @NonNull ServerMessage sourceMessage, @NonNull Channel channel, boolean updated) Deprecated. Use new constructor
ChannelTopicEvent(@NonNull Client client, @NonNull ServerMessage sourceMessage, @NonNull Channel channel, Channel.Topic oldTopic, Channel.Topic newTopic, boolean updated) Creates the event.

Method Summary

Modifier and Type	Method and Description
Channel.Topic	getNewTopic()
Channel.Topic	getOldTopic()
Channel.Topic	getTopic() Deprecated. Use getNewTopic() and getOldTopic()
boolean	isNew() Gets if this is a new topic update, or just the server informing us of a change from the past.
protected @NonNull ToStringer	toStringer() Generates a partial ToStringer for the command.

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ChannelEventBase

getChannel

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

getSource

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

getClient, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ServerMessageEvent

getTag, getTag, getTags

Constructor Detail

ChannelTopicEvent

public ChannelTopicEvent(@NonNull Client client,
                         @NonNull ServerMessage sourceMessage,
                         @NonNull Channel channel,
                         Channel.Topic oldTopic,
                         Channel.Topic newTopic,
                         boolean updated)

Creates the event.

Parameters:

client - client for which this is occurring

sourceMessage - source message

channel - channel the topic is about

oldTopic - old topic

newTopic - new topic

updated - if this is a new change

ChannelTopicEvent

@Deprecated
public ChannelTopicEvent(@NonNull Client client,
                                      @NonNull ServerMessage sourceMessage,
                                      @NonNull Channel channel,
                                      boolean updated)

Deprecated. Use new constructor

Creates the event.

Parameters:

client - client for which this is occurring

sourceMessage - source message

channel - channel the topic is about

updated - if this is a new change

Method Detail

getTopic

@Deprecated
public Channel.Topic getTopic()

Deprecated. Use getNewTopic() and getOldTopic()

Gets the channel's topic.

Returns:

the channel topic

getNewTopic

public Channel.Topic getNewTopic()

getOldTopic

public Channel.Topic getOldTopic()

isNew

public boolean isNew()

Gets if this is a new topic update, or just the server informing us of a change from the past.

Returns:

true if a new topic change

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ChannelEventBase

Returns:

the partial toString generator