Add input stream that counts its consumed bandwidth.
[xudocci.git] / src / main / java / net / pterodactylus / irc / event / ChannelNotJoined.java
1 /*
2  * XdccDownloader - ChannelNotJoined.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 channel could not be joined.
24  *
25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
26  */
27 public class ChannelNotJoined extends AbstractChannelEvent {
28
29         /** The possible reasons for the failure to join a channel. */
30         public enum Reason {
31
32                 channelIsFull,
33                 inviteOnly,
34                 banned,
35                 badChannelKey,
36                 badChannelMask,
37                 noSuchChannel,
38                 tooManyChannels,
39                 tooManyTargets,
40                 unavailable
41
42         }
43
44         /** The reason for the join failure. */
45         private final Reason reason;
46
47         /**
48          * Creates a new channel not joined event.
49          *
50          * @param connection
51          *              The connection this event occured on
52          * @param channel
53          *              The channel that could not be joined
54          * @param reason
55          *              The reason for the failure to join the channel
56          */
57         public ChannelNotJoined(Connection connection, String channel, Reason reason) {
58                 super(connection, channel);
59                 this.reason = reason;
60         }
61
62         //
63         // ACCESSORS
64         //
65
66         /**
67          * Returns the reason for the failure to join the channel.
68          *
69          * @return The reason for the failure to join the channel
70          */
71         public Reason reason() {
72                 return reason;
73         }
74
75 }