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

   1 /*
   2  * XdccDownloader - AbstractReplyEvent.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.Reply;
  22
  23 /**
  24  * Abstract base class for all events based on {@link Reply}s (and thus very low
  25  * level). Examples would be e.g. nick changing messages, mode changes, private
  26  * messages, and other single/global events that do not carry state.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public abstract class AbstractReplyEvent extends AbstractConnectionEvent {
  31
  32         /** The reply that caused this event. */
  33         private final Reply reply;
  34
  35         /**
  36          * Creates a new abstract reply event.
  37          *
  38          * @param connection
  39          *              The connection the event occured on
  40          * @param reply
  41          *              The reply that caused this event
  42          */
  43         protected AbstractReplyEvent(Connection connection, Reply reply) {
  44                 super(connection);
  45                 this.reply = reply;
  46         }
  47
  48         //
  49         // ACCESSORS
  50         //
  51
  52         /**
  53          * Returns the reply that caused this event.
  54          *
  55          * @return The reply that caused this event
  56          */
  57         public Reply reply() {
  58                 return reply;
  59         }
  60
  61 }