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                 registeredNicknamesOnly
  42
  43         }
  44
  45         /** The reason for the join failure. */
  46         private final Reason reason;
  47
  48         /**
  49          * Creates a new channel not joined event.
  50          *
  51          * @param connection
  52          *              The connection this event occured on
  53          * @param channel
  54          *              The channel that could not be joined
  55          * @param reason
  56          *              The reason for the failure to join the channel
  57          */
  58         public ChannelNotJoined(Connection connection, String channel, Reason reason) {
  59                 super(connection, channel);
  60                 this.reason = reason;
  61         }
  62
  63         //
  64         // ACCESSORS
  65         //
  66
  67         /**
  68          * Returns the reason for the failure to join the channel.
  69          *
  70          * @return The reason for the failure to join the channel
  71          */
  72         public Reason reason() {
  73                 return reason;
  74         }
  75
  76 }