src/main/java/irc/ChannelListener.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  * Channel listener. Use ChannelListener2 instead.\r
  34  */\r
  35 public interface ChannelListener extends SourceListener {\r
  36         /**\r
  37          * The channel has changed all its nick list.\r
  38          * \r
  39          * @param nicks\r
  40          *          new nicks.\r
  41          * @param modes\r
  42          *          new modes.\r
  43          * @param channel\r
  44          *          the channel.\r
  45          */\r
  46         public void nickSet(String nicks[], String modes[], Channel channel);\r
  47 \r
  48         /**\r
  49          * A new nick has joined.\r
  50          * \r
  51          * @param nick\r
  52          *          the nick who joined.\r
  53          * @param mode\r
  54          *          nick mode.\r
  55          * @param channel\r
  56          *          the channel.\r
  57          */\r
  58         public void nickJoin(String nick, String mode, Channel channel);\r
  59 \r
  60         /**\r
  61          * A nick has quit.\r
  62          * \r
  63          * @param nick\r
  64          *          the nick who quit.\r
  65          * @param reason\r
  66          *          reason.\r
  67          * @param channel\r
  68          *          the channel.\r
  69          */\r
  70         public void nickQuit(String nick, String reason, Channel channel);\r
  71 \r
  72         /**\r
  73          * A nick has part.\r
  74          * \r
  75          * @param nick\r
  76          *          the nick who part.\r
  77          * @param reason\r
  78          *          reason.\r
  79          * @param channel\r
  80          *          the channel.\r
  81          */\r
  82         public void nickPart(String nick, String reason, Channel channel);\r
  83 \r
  84         /**\r
  85          * A nick has been kicked.\r
  86          * \r
  87          * @param nick\r
  88          *          the nick who has been kicked.\r
  89          * @param by\r
  90          *          the nick who kicked.\r
  91          * @param reason\r
  92          *          kick reason.\r
  93          * @param channel\r
  94          *          the channel.\r
  95          */\r
  96         public void nickKick(String nick, String by, String reason, Channel channel);\r
  97 \r
  98         /**\r
  99          * The topic has been changed.\r
 100          * \r
 101          * @param topic\r
 102          *          new topic.\r
 103          * @param by\r
 104          *          user who changed topic.\r
 105          * @param channel\r
 106          *          the channel.\r
 107          */\r
 108         public void topicChanged(String topic, String by, Channel channel);\r
 109 \r
 110         /**\r
 111          * Channel mode applied.\r
 112          * \r
 113          * @param mode\r
 114          *          applied mode.\r
 115          * @param from\r
 116          *          user who applied mode.\r
 117          * @param channel\r
 118          *          the channel.\r
 119          */\r
 120         public void modeApply(String mode, String from, Channel channel);\r
 121 \r
 122         /**\r
 123          * Nick mode applied.\r
 124          * \r
 125          * @param nick\r
 126          *          user on wich mode applied.\r
 127          * @param mode\r
 128          *          applied mode.\r
 129          * @param from\r
 130          *          user who applied mode.\r
 131          * @param channel\r
 132          *          the channel.\r
 133          */\r
 134         public void nickModeApply(String nick, String mode, String from, Channel channel);\r
 135 \r
 136         /**\r
 137          * Nick changed.\r
 138          * \r
 139          * @param oldNick\r
 140          *          old nick.\r
 141          * @param newNick\r
 142          *          new nick.\r
 143          * @param channel\r
 144          *          the channel.\r
 145          */\r
 146         public void nickChanged(String oldNick, String newNick, Channel channel);\r
 147 \r
 148         /**\r
 149          * Whois bufferised information has been updated.\r
 150          * \r
 151          * @param nick\r
 152          *          nick on wich new whois information is available.\r
 153          * @param whois\r
 154          *          whois string for nick.\r
 155          * @param channel\r
 156          *          the channel.\r
 157          */\r
 158         public void nickWhoisUpdated(String nick, String whois, Channel channel);\r
 159 }\r