src/main/java/irc/StartupConfiguration.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  * Startup configuration.\r
  34  */\r
  35 public class StartupConfiguration {\r
  36         private String _nick;\r
  37         private String _altNick;\r
  38         private String _name;\r
  39         private String[] _pass;\r
  40         private String[] _host;\r
  41         private String _alias;\r
  42         private int[] _port;\r
  43         private String[] _commands;\r
  44         private String[] _plugins;\r
  45 \r
  46         /**\r
  47          * Create a new StartupConfiguration.\r
  48          * \r
  49          * @param nick\r
  50          *          claimed nickname.\r
  51          * @param altNick\r
  52          *          claimed alternate nickname.\r
  53          * @param name\r
  54          *          full user name.\r
  55          * @param pass\r
  56          *          user server passwords.\r
  57          * @param host\r
  58          *          IRC server hosts.\r
  59          * @param port\r
  60          *          IRC server ports.\r
  61          * @param alias\r
  62          *          IRC server alias.\r
  63          * @param commands\r
  64          *          initial server commands.\r
  65          * @param plugins\r
  66          *          autoloaded plugins.\r
  67          */\r
  68         public StartupConfiguration(String nick, String altNick, String name, String pass[], String host[], int port[],\r
  69                         String alias, String[] commands, String[] plugins) {\r
  70                 _nick = nick;\r
  71                 _altNick = altNick;\r
  72                 _name = name;\r
  73                 _pass = pass;\r
  74                 _host = host;\r
  75                 _port = port;\r
  76                 _alias = alias;\r
  77                 _commands = commands;\r
  78                 _plugins = plugins;\r
  79         }\r
  80 \r
  81         /**\r
  82          * Get the nickname.\r
  83          * \r
  84          * @return the nickname.\r
  85          */\r
  86         public String getNick() {\r
  87                 return _nick;\r
  88         }\r
  89 \r
  90         /**\r
  91          * Get the alternate nickname.\r
  92          * \r
  93          * @return the alternate nickname.\r
  94          */\r
  95         public String getAltNick() {\r
  96                 return _altNick;\r
  97         }\r
  98 \r
  99         /**\r
 100          * Get the full name.\r
 101          * \r
 102          * @return the full name.\r
 103          */\r
 104         public String getName() {\r
 105                 return _name;\r
 106         }\r
 107 \r
 108         /**\r
 109          * Get the server passwords.\r
 110          * \r
 111          * @return the server passwords.\r
 112          */\r
 113         public String[] getPass() {\r
 114                 return _pass;\r
 115         }\r
 116 \r
 117         /**\r
 118          * Get the server host names.\r
 119          * \r
 120          * @return the server host names.\r
 121          */\r
 122         public String[] getHost() {\r
 123                 return _host;\r
 124         }\r
 125 \r
 126         /**\r
 127          * Get the server ports.\r
 128          * \r
 129          * @return the server ports.\r
 130          */\r
 131         public int[] getPort() {\r
 132                 return _port;\r
 133         }\r
 134 \r
 135         /**\r
 136          * Get the server alias.\r
 137          * \r
 138          * @return the server alias.\r
 139          */\r
 140         public String getAlias() {\r
 141                 return _alias;\r
 142         }\r
 143 \r
 144         /**\r
 145          * Get initial server commands.\r
 146          * \r
 147          * @return initial on-connect server commands.\r
 148          */\r
 149         public String[] getCommands() {\r
 150                 return _commands;\r
 151         }\r
 152 \r
 153         /**\r
 154          * Get the autoloaded scripts.\r
 155          * \r
 156          * @return autoloaded scripts.\r
 157          */\r
 158         public String[] getPlugins() {\r
 159                 return _plugins;\r
 160         }\r
 161 }\r