🚧 Parse token from DCC SEND
[xudocci.git] / irc / event / ConnectionClosed.java
1 /*
2  * XdccDownloader - ConnectionClosed.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 import com.google.common.base.Optional;
23
24 /**
25  * Notifies a listener that a connection to an IRC server was closed.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David â€˜Bombe’ Roden</a>
28  */
29 public class ConnectionClosed extends AbstractConnectionEvent {
30
31         /** The optional cause of the connection closing. */
32         private final Optional<Throwable> cause;
33
34         /**
35          * Creates a new connection established event.
36          *
37          * @param connection
38          *              The connection the event occured on
39          */
40         public ConnectionClosed(Connection connection) {
41                 this(connection, null);
42         }
43
44         /**
45          * Creates a new connection established event.
46          *
47          * @param connection
48          *              The connection the event occured on
49          * @param cause
50          *              The cause of the connection closing
51          */
52         public ConnectionClosed(Connection connection, Throwable cause) {
53                 super(connection);
54                 this.cause = Optional.fromNullable(cause);
55         }
56
57         //
58         // ACCESSORS
59         //
60
61         /**
62          * Returns the cause of the connection closing.
63          *
64          * @return The cause of the connection closing, or {@link Optional#absent()} if
65          *         the connection was closed properly
66          */
67         public Optional<Throwable> cause() {
68                 return cause;
69         }
70
71 }