src/main/java/net/pterodactylus/irc/event/ChannelTopic.java

   1 /*
   2  * XdccDownloader - ChannelTopic.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.irc.event;
  19
  20 import net.pterodactylus.irc.Connection;
  21
  22 /**
  23  * Notifies a listener that a channel topic has been set.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public class ChannelTopic extends AbstractChannelEvent {
  28
  29         /** The topic that has been set. */
  30         private final String topic;
  31
  32         /**
  33          * Creates a new channel topic event.
  34          *
  35          * @param connection
  36          *              The connection the event occured on
  37          * @param channel
  38          *              The channel the topic was set on
  39          * @param topic
  40          *              The topic that was set
  41          */
  42         public ChannelTopic(Connection connection, String channel, String topic) {
  43                 super(connection, channel);
  44                 this.topic = topic;
  45         }
  46
  47         //
  48         // ACCESSORS
  49         //
  50
  51         /**
  52          * Returns the topic that was set.
  53          *
  54          * @return The topic that was set
  55          */
  56         public String topic() {
  57                 return topic;
  58         }
  59
  60 }