Send an event if the connection is terminated for whatever reason.

[xudocci.git] / src / main / java / net / pterodactylus / irc / event / ConnectionClosed.java

diff --git a/src/main/java/net/pterodactylus/irc/event/ConnectionClosed.java b/src/main/java/net/pterodactylus/irc/event/ConnectionClosed.java
new file mode 100644 (file)
index 0000000..184f1f1
--- /dev/null
+++ b/src/main/java/net/pterodactylus/irc/event/ConnectionClosed.java
@@ -0,0 +1,71 @@
+/*
+ * XdccDownloader - ConnectionClosed.java - Copyright © 2013 David Roden
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.irc.event;
+
+import net.pterodactylus.irc.Connection;
+
+import com.google.common.base.Optional;
+
+/**
+ * Notifies a listener that a connection to an IRC server was closed.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public class ConnectionClosed extends AbstractConnectionEvent {
+
+       /** The optional cause of the connection closing. */
+       private final Optional<Throwable> cause;
+
+       /**
+        * Creates a new connection established event.
+        *
+        * @param connection
+        *              The connection the event occured on
+        */
+       public ConnectionClosed(Connection connection) {
+               this(connection, null);
+       }
+
+       /**
+        * Creates a new connection established event.
+        *
+        * @param connection
+        *              The connection the event occured on
+        * @param cause
+        *              The cause of the connection closing
+        */
+       public ConnectionClosed(Connection connection, Throwable cause) {
+               super(connection);
+               this.cause = Optional.fromNullable(cause);
+       }
+
+       //
+       // ACCESSORS
+       //
+
+       /**
+        * Returns the cause of the connection closing.
+        *
+        * @return The cause of the connection closing, or {@link Optional#absent()} if
+        *         the connection was closed properly
+        */
+       public Optional<Throwable> cause() {
+               return cause;
+       }
+
+}