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

   1 /*
   2  * XdccDownloader - NicknameInUseReceived.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 import net.pterodactylus.irc.Reply;
  22
  23 /**
  24  * Notifies a listener that a nickname is already in use.
  25  *
  26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  27  */
  28 public class NicknameInUseReceived extends AbstractReplyEvent {
  29
  30         /** The nickname that is already in use. */
  31         private final String nickname;
  32
  33         /** The message from the server. */
  34         private final String message;
  35
  36         /**
  37          * Creates a new nickname in use event.
  38          *
  39          * @param connection
  40          *              The connection the event occured on
  41          * @param reply
  42          *              The reply that caused the event
  43          */
  44         public NicknameInUseReceived(Connection connection, Reply reply) {
  45                 super(connection, reply);
  46                 nickname = reply.parameters().get(0);
  47                 message = reply.parameters().get(1);
  48         }
  49
  50         //
  51         // ACCESSORS
  52         //
  53
  54         /**
  55          * Returns the nickname that is already in use.
  56          *
  57          * @return The nickname that is already in use
  58          */
  59         public String nickname() {
  60                 return nickname;
  61         }
  62
  63         /**
  64          * Returns the message from the IRC server.
  65          *
  66          * @return The message from the IRC server
  67          */
  68         public String message() {
  69                 return message;
  70         }
  71
  72 }