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

   1 /*
   2  * XdccDownloader - AbstractConnectionEvent.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  * Abstract base class for all {@link Connection}-related events.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public abstract class AbstractConnectionEvent {
  28
  29         /** The connection the event occured on. */
  30         private final Connection connection;
  31
  32         /**
  33          * Creates a new abstract connection event.
  34          *
  35          * @param connection
  36          *              The connection the event occured on
  37          */
  38         protected AbstractConnectionEvent(Connection connection) {
  39                 this.connection = connection;
  40         }
  41
  42         //
  43         // ACCESSORS
  44         //
  45
  46         /**
  47          * Returns the connection the event occured on.
  48          *
  49          * @return The connection the event occured on
  50          */
  51         public Connection connection() {
  52                 return connection;
  53         }
  54
  55 }