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

   1 /*
   2  * XdccDownloader - Nick.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  * Container for a nickname and a prefix. The prefix is a character specific to
  22  * an IRC server that denotes some kind of special status of a nickname in a
  23  * channel. The most commonly known prefixes are “@” (for operators) and “+”
  24  * (for voiced clients) but newer IRCds know other prefixes, such as “!” and
  25  * “%”, too.
  26  *
  27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  28  */
  29 public class Nickname {
  30
  31         /** The name. */
  32         private final String name;
  33
  34         /** The prefix. */
  35         private final String prefix;
  36
  37         /**
  38          * Creates a new nickname.
  39          *
  40          * @param name
  41          *              The name of the nickname
  42          * @param prefix
  43          *              The prefix of the nickname
  44          */
  45         public Nickname(String name, String prefix) {
  46                 this.name = name;
  47                 this.prefix = prefix;
  48         }
  49
  50         //
  51         // ACCESSORS
  52         //
  53
  54         /**
  55          * Returns the name of the nickname.
  56          *
  57          * @return The name of the nickname
  58          */
  59         public String name() {
  60                 return name;
  61         }
  62
  63         /**
  64          * Returns the prefix of the nickname.
  65          *
  66          * @return The prefix of the nickname (or an empty string if this nickname does
  67          *         not have a prefix)
  68          */
  69         public String prefix() {
  70                 return prefix;
  71         }
  72
  73         //
  74         // OBJECT METHODS
  75         //
  76
  77         @Override
  78         public String toString() {
  79                 return prefix + name;
  80         }
  81
  82 }