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

   1 /*
   2  * XdccDownloader - ConnectionFailed.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 connection to an IRC server could not be
  24  * established.
  25  *
  26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  27  */
  28 public class ConnectionFailed extends AbstractConnectionEvent {
  29
  30         /** The cause of the connection failure. */
  31         private final Throwable cause;
  32
  33         /**
  34          * Creates a new connection failure event.
  35          *
  36          * @param connection
  37          *              The connection the event occured on
  38          * @param cause
  39          *              The cause of the connection failure
  40          */
  41         public ConnectionFailed(Connection connection, Throwable cause) {
  42                 super(connection);
  43                 this.cause = cause;
  44         }
  45
  46         //
  47         // ACCESSORS
  48         //
  49
  50         /**
  51          * Returns the cause of the connection failure.
  52          *
  53          * @return The cause of the connection failure
  54          */
  55         public Throwable cause() {
  56                 return cause;
  57         }
  58
  59 }