src/jalview/binding/JalviewModelSequence2Item.java

   1 /*\r
   2  * This class was automatically generated with\r
   3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
   4  * Schema.\r
   5  * $Id$\r
   6  */\r
   7 /*\r
   8 * Jalview - A Sequence Alignment Editor and Viewer\r
   9 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
  10 *\r
  11 * This program is free software; you can redistribute it and/or\r
  12 * modify it under the terms of the GNU General Public License\r
  13 * as published by the Free Software Foundation; either version 2\r
  14 * of the License, or (at your option) any later version.\r
  15 *\r
  16 * This program is distributed in the hope that it will be useful,\r
  17 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  19 * GNU General Public License for more details.\r
  20 *\r
  21 * You should have received a copy of the GNU General Public License\r
  22 * along with this program; if not, write to the Free Software\r
  23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  24 */\r
  25 package jalview.binding;\r
  26 \r
  27 import org.exolab.castor.xml.Marshaller;\r
  28 import org.exolab.castor.xml.Unmarshaller;\r
  29 \r
  30 //---------------------------------/\r
  31 //- Imported classes and packages -/\r
  32 //---------------------------------/\r
  33 import java.io.Serializable;\r
  34 \r
  35 import java.util.Enumeration;\r
  36 import java.util.Vector;\r
  37 \r
  38 \r
  39 /**\r
  40  * Class JalviewModelSequence2Item.\r
  41  *\r
  42  * @version $Revision$ $Date$\r
  43  */\r
  44 public class JalviewModelSequence2Item implements java.io.Serializable {\r
  45     //--------------------------/\r
  46     //- Class/Member Variables -/\r
  47     //--------------------------/\r
  48 \r
  49     /**\r
  50      * Field _userColourSchemeList\r
  51      */\r
  52     private java.util.Vector _userColourSchemeList;\r
  53 \r
  54     //----------------/\r
  55     //- Constructors -/\r
  56     //----------------/\r
  57     public JalviewModelSequence2Item() {\r
  58         super();\r
  59         _userColourSchemeList = new Vector();\r
  60     }\r
  61      //-- jalview.binding.JalviewModelSequence2Item()\r
  62  //-----------/\r
  63 \r
  64     public void addUserColourScheme(\r
  65         jalview.binding.UserColourScheme vUserColourScheme)\r
  66         throws java.lang.IndexOutOfBoundsException {\r
  67         _userColourSchemeList.addElement(vUserColourScheme);\r
  68     }\r
  69      //-- void addUserColourScheme(jalview.binding.UserColourScheme)\r
  70 \r
  71     /**\r
  72      * Method addUserColourScheme\r
  73      *\r
  74      *\r
  75      *\r
  76      * @param index\r
  77      * @param vUserColourScheme\r
  78      */\r
  79     public void addUserColourScheme(int index,\r
  80         jalview.binding.UserColourScheme vUserColourScheme)\r
  81         throws java.lang.IndexOutOfBoundsException {\r
  82         _userColourSchemeList.insertElementAt(vUserColourScheme, index);\r
  83     }\r
  84      //-- void addUserColourScheme(int, jalview.binding.UserColourScheme)\r
  85 \r
  86     /**\r
  87      * Method enumerateUserColourScheme\r
  88      *\r
  89      *\r
  90      *\r
  91      * @return Enumeration\r
  92      */\r
  93     public java.util.Enumeration enumerateUserColourScheme() {\r
  94         return _userColourSchemeList.elements();\r
  95     }\r
  96      //-- java.util.Enumeration enumerateUserColourScheme()\r
  97 \r
  98     /**\r
  99      * Method getUserColourScheme\r
 100      *\r
 101      *\r
 102      *\r
 103      * @param index\r
 104      * @return UserColourScheme\r
 105      */\r
 106     public jalview.binding.UserColourScheme getUserColourScheme(int index)\r
 107         throws java.lang.IndexOutOfBoundsException {\r
 108         //-- check bounds for index\r
 109         if ((index < 0) || (index > _userColourSchemeList.size())) {\r
 110             throw new IndexOutOfBoundsException();\r
 111         }\r
 112 \r
 113         return (jalview.binding.UserColourScheme) _userColourSchemeList.elementAt(index);\r
 114     }\r
 115      //-- jalview.binding.UserColourScheme getUserColourScheme(int)\r
 116 \r
 117     /**\r
 118      * Method getUserColourScheme\r
 119      *\r
 120      *\r
 121      *\r
 122      * @return UserColourScheme\r
 123      */\r
 124     public jalview.binding.UserColourScheme[] getUserColourScheme() {\r
 125         int size = _userColourSchemeList.size();\r
 126         jalview.binding.UserColourScheme[] mArray = new jalview.binding.UserColourScheme[size];\r
 127 \r
 128         for (int index = 0; index < size; index++) {\r
 129             mArray[index] = (jalview.binding.UserColourScheme) _userColourSchemeList.elementAt(index);\r
 130         }\r
 131 \r
 132         return mArray;\r
 133     }\r
 134      //-- jalview.binding.UserColourScheme[] getUserColourScheme()\r
 135 \r
 136     /**\r
 137      * Method getUserColourSchemeCount\r
 138      *\r
 139      *\r
 140      *\r
 141      * @return int\r
 142      */\r
 143     public int getUserColourSchemeCount() {\r
 144         return _userColourSchemeList.size();\r
 145     }\r
 146      //-- int getUserColourSchemeCount()\r
 147 \r
 148     /**\r
 149      * Method removeAllUserColourScheme\r
 150      *\r
 151      */\r
 152     public void removeAllUserColourScheme() {\r
 153         _userColourSchemeList.removeAllElements();\r
 154     }\r
 155      //-- void removeAllUserColourScheme()\r
 156 \r
 157     /**\r
 158      * Method removeUserColourScheme\r
 159      *\r
 160      *\r
 161      *\r
 162      * @param index\r
 163      * @return UserColourScheme\r
 164      */\r
 165     public jalview.binding.UserColourScheme removeUserColourScheme(int index) {\r
 166         java.lang.Object obj = _userColourSchemeList.elementAt(index);\r
 167         _userColourSchemeList.removeElementAt(index);\r
 168 \r
 169         return (jalview.binding.UserColourScheme) obj;\r
 170     }\r
 171      //-- jalview.binding.UserColourScheme removeUserColourScheme(int)\r
 172 \r
 173     /**\r
 174      * Method setUserColourScheme\r
 175      *\r
 176      *\r
 177      *\r
 178      * @param index\r
 179      * @param vUserColourScheme\r
 180      */\r
 181     public void setUserColourScheme(int index,\r
 182         jalview.binding.UserColourScheme vUserColourScheme)\r
 183         throws java.lang.IndexOutOfBoundsException {\r
 184         //-- check bounds for index\r
 185         if ((index < 0) || (index > _userColourSchemeList.size())) {\r
 186             throw new IndexOutOfBoundsException();\r
 187         }\r
 188 \r
 189         _userColourSchemeList.setElementAt(vUserColourScheme, index);\r
 190     }\r
 191      //-- void setUserColourScheme(int, jalview.binding.UserColourScheme)\r
 192 \r
 193     /**\r
 194      * Method setUserColourScheme\r
 195      *\r
 196      *\r
 197      *\r
 198      * @param userColourSchemeArray\r
 199      */\r
 200     public void setUserColourScheme(\r
 201         jalview.binding.UserColourScheme[] userColourSchemeArray) {\r
 202         //-- copy array\r
 203         _userColourSchemeList.removeAllElements();\r
 204 \r
 205         for (int i = 0; i < userColourSchemeArray.length; i++) {\r
 206             _userColourSchemeList.addElement(userColourSchemeArray[i]);\r
 207         }\r
 208     }\r
 209      //-- void setUserColourScheme(jalview.binding.UserColourScheme)\r
 210 }\r