src/main/java/irc/TextProvider.java

   1 /*****************************************************/\r
   2 /*          This java file is a part of the          */\r
   3 /*                                                   */\r
   4 /*           -  Plouf's Java IRC Client  -           */\r
   5 /*                                                   */\r
   6 /*   Copyright (C)  2002 - 2004 Philippe Detournay   */\r
   7 /*                                                   */\r
   8 /*         All contacts : theplouf@yahoo.com         */\r
   9 /*                                                   */\r
  10 /*  PJIRC is free software; you can redistribute     */\r
  11 /*  it and/or modify it under the terms of the GNU   */\r
  12 /*  General Public License as published by the       */\r
  13 /*  Free Software Foundation; version 2 or later of  */\r
  14 /*  the License.                                     */\r
  15 /*                                                   */\r
  16 /*  PJIRC is distributed in the hope that it will    */\r
  17 /*  be useful, but WITHOUT ANY WARRANTY; without     */\r
  18 /*  even the implied warranty of MERCHANTABILITY or  */\r
  19 /*  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU   */\r
  20 /*  General Public License for more details.         */\r
  21 /*                                                   */\r
  22 /*  You should have received a copy of the GNU       */\r
  23 /*  General Public License along with PJIRC; if      */\r
  24 /*  not, write to the Free Software Foundation,      */\r
  25 /*  Inc., 59 Temple Place, Suite 330, Boston,        */\r
  26 /*  MA  02111-1307  USA                              */\r
  27 /*                                                   */\r
  28 /*****************************************************/\r
  29 \r
  30 package irc;\r
  31 \r
  32 /**\r
  33  * The text provider.\r
  34  */\r
  35 public interface TextProvider {\r
  36 \r
  37         /**\r
  38          * First user message.\r
  39          */\r
  40         public static final int USER_BASE = 0x8000;\r
  41         /**\r
  42          * Undefined string.\r
  43          */\r
  44         public static final int ERROR_NOT_DEFINED = 0xffff;\r
  45 \r
  46         /**\r
  47          * Get the formatted string.\r
  48          * \r
  49          * @param formattedCode\r
  50          *          string code.\r
  51          * @param param\r
  52          *          parameters.\r
  53          * @return formatted string.\r
  54          */\r
  55         public String getString(int formattedCode, String param[]);\r
  56 \r
  57         /**\r
  58          * Get the formatted string.\r
  59          * \r
  60          * @param code\r
  61          *          string code.\r
  62          * @return formatted string.\r
  63          */\r
  64         public String getString(int code);\r
  65 \r
  66         /**\r
  67          * Get the formatted string.\r
  68          * \r
  69          * @param code\r
  70          *          string code.\r
  71          * @param param1\r
  72          *          first parameter.\r
  73          * @return formatted string.\r
  74          */\r
  75         public String getString(int code, String param1);\r
  76 \r
  77         /**\r
  78          * Get the formatted string.\r
  79          * \r
  80          * @param code\r
  81          *          string code.\r
  82          * @param param1\r
  83          *          first parameter.\r
  84          * @param param2\r
  85          *          second parameter.\r
  86          * @return formatted string.\r
  87          */\r
  88         public String getString(int code, String param1, String param2);\r
  89 \r
  90         /**\r
  91          * Get the formatted string.\r
  92          * \r
  93          * @param code\r
  94          *          string code.\r
  95          * @param param1\r
  96          *          first parameter.\r
  97          * @param param2\r
  98          *          second parameter.\r
  99          * @param param3\r
 100          *          third parameter.\r
 101          * @return formatted string.\r
 102          */\r
 103         public String getString(int code, String param1, String param2, String param3);\r
 104 \r
 105 }\r