src/main/java/net/pterodactylus/irc/NicknameChooser.java

   1 /*
   2  * XdccDownloader - NicknameChooser.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;
  19
  20 /**
  21  * A nickname choose is used to get a new nickname. It is used by the {@link
  22  * Connection} to retrieve the initial nickname of the connection, and it’s also
  23  * used in case a nick change results in a “nickname already in use” error.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public interface NicknameChooser {
  28
  29         /**
  30          * Returns a nickname to use.
  31          *
  32          * @return A nickname
  33          */
  34         public String getNickname();
  35
  36 }