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

   1 /*
   2  * XdccDownloader - ChannelNoticeReceived.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 import net.pterodactylus.irc.Source;
  22
  23 /**
  24  * Notifies a listener that a notice was received on a channel.
  25  *
  26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  27  */
  28 public class ChannelNoticeReceived extends AbstractChannelEvent {
  29
  30         private final Source client;
  31
  32         /** The text of the notice. */
  33         private final String text;
  34
  35         /**
  36          * Creates a new notice received event.
  37          *
  38          * @param connection
  39          *              The connection the event occured on
  40          * @param reply
  41          *              The reply that caused the event
  42          */
  43         public ChannelNoticeReceived(Connection connection, Source client, String channel, String text) {
  44                 super(connection, channel);
  45                 this.client = client;
  46                 this.text = text;
  47         }
  48
  49         //
  50         // ACCESSORS
  51         //
  52
  53         /**
  54          * Returns the target of the notice.
  55          *
  56          * @return The target of the notice
  57          */
  58         public Source client() {
  59                 return client;
  60         }
  61
  62         /**
  63          * Returns the text of the notice.
  64          *
  65          * @return The text of the notice
  66          */
  67         public String text() {
  68                 return text;
  69         }
  70
  71 }