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 package jalview.binding;\r
   9 \r
  10   //---------------------------------/\r
  11  //- Imported classes and packages -/\r
  12 //---------------------------------/\r
  13 \r
  14 import java.io.Serializable;\r
  15 import java.util.Enumeration;\r
  16 import java.util.Vector;\r
  17 import org.exolab.castor.xml.Marshaller;\r
  18 import org.exolab.castor.xml.Unmarshaller;\r
  19 \r
  20 /**\r
  21  * Class JalviewModelSequence2Item.\r
  22  * \r
  23  * @version $Revision$ $Date$\r
  24  */\r
  25 public class JalviewModelSequence2Item implements java.io.Serializable {\r
  26 \r
  27 \r
  28       //--------------------------/\r
  29      //- Class/Member Variables -/\r
  30     //--------------------------/\r
  31 \r
  32     /**\r
  33      * Field _userColourSchemeList\r
  34      */\r
  35     private java.util.Vector _userColourSchemeList;\r
  36 \r
  37 \r
  38       //----------------/\r
  39      //- Constructors -/\r
  40     //----------------/\r
  41 \r
  42     public JalviewModelSequence2Item() {\r
  43         super();\r
  44         _userColourSchemeList = new Vector();\r
  45     } //-- jalview.binding.JalviewModelSequence2Item()\r
  46 \r
  47 \r
  48       //-----------/\r
  49      //- Methods -/\r
  50     //-----------/\r
  51 \r
  52     /**\r
  53      * Method addUserColourScheme\r
  54      * \r
  55      * \r
  56      * \r
  57      * @param vUserColourScheme\r
  58      */\r
  59     public void addUserColourScheme(jalview.binding.UserColourScheme vUserColourScheme)\r
  60         throws java.lang.IndexOutOfBoundsException\r
  61     {\r
  62         _userColourSchemeList.addElement(vUserColourScheme);\r
  63     } //-- void addUserColourScheme(jalview.binding.UserColourScheme) \r
  64 \r
  65     /**\r
  66      * Method addUserColourScheme\r
  67      * \r
  68      * \r
  69      * \r
  70      * @param index\r
  71      * @param vUserColourScheme\r
  72      */\r
  73     public void addUserColourScheme(int index, jalview.binding.UserColourScheme vUserColourScheme)\r
  74         throws java.lang.IndexOutOfBoundsException\r
  75     {\r
  76         _userColourSchemeList.insertElementAt(vUserColourScheme, index);\r
  77     } //-- void addUserColourScheme(int, jalview.binding.UserColourScheme) \r
  78 \r
  79     /**\r
  80      * Method enumerateUserColourScheme\r
  81      * \r
  82      * \r
  83      * \r
  84      * @return Enumeration\r
  85      */\r
  86     public java.util.Enumeration enumerateUserColourScheme()\r
  87     {\r
  88         return _userColourSchemeList.elements();\r
  89     } //-- java.util.Enumeration enumerateUserColourScheme() \r
  90 \r
  91     /**\r
  92      * Method getUserColourScheme\r
  93      * \r
  94      * \r
  95      * \r
  96      * @param index\r
  97      * @return UserColourScheme\r
  98      */\r
  99     public jalview.binding.UserColourScheme getUserColourScheme(int index)\r
 100         throws java.lang.IndexOutOfBoundsException\r
 101     {\r
 102         //-- check bounds for index\r
 103         if ((index < 0) || (index > _userColourSchemeList.size())) {\r
 104             throw new IndexOutOfBoundsException();\r
 105         }\r
 106         \r
 107         return (jalview.binding.UserColourScheme) _userColourSchemeList.elementAt(index);\r
 108     } //-- jalview.binding.UserColourScheme getUserColourScheme(int) \r
 109 \r
 110     /**\r
 111      * Method getUserColourScheme\r
 112      * \r
 113      * \r
 114      * \r
 115      * @return UserColourScheme\r
 116      */\r
 117     public jalview.binding.UserColourScheme[] getUserColourScheme()\r
 118     {\r
 119         int size = _userColourSchemeList.size();\r
 120         jalview.binding.UserColourScheme[] mArray = new jalview.binding.UserColourScheme[size];\r
 121         for (int index = 0; index < size; index++) {\r
 122             mArray[index] = (jalview.binding.UserColourScheme) _userColourSchemeList.elementAt(index);\r
 123         }\r
 124         return mArray;\r
 125     } //-- jalview.binding.UserColourScheme[] getUserColourScheme() \r
 126 \r
 127     /**\r
 128      * Method getUserColourSchemeCount\r
 129      * \r
 130      * \r
 131      * \r
 132      * @return int\r
 133      */\r
 134     public int getUserColourSchemeCount()\r
 135     {\r
 136         return _userColourSchemeList.size();\r
 137     } //-- int getUserColourSchemeCount() \r
 138 \r
 139     /**\r
 140      * Method removeAllUserColourScheme\r
 141      * \r
 142      */\r
 143     public void removeAllUserColourScheme()\r
 144     {\r
 145         _userColourSchemeList.removeAllElements();\r
 146     } //-- void removeAllUserColourScheme() \r
 147 \r
 148     /**\r
 149      * Method removeUserColourScheme\r
 150      * \r
 151      * \r
 152      * \r
 153      * @param index\r
 154      * @return UserColourScheme\r
 155      */\r
 156     public jalview.binding.UserColourScheme removeUserColourScheme(int index)\r
 157     {\r
 158         java.lang.Object obj = _userColourSchemeList.elementAt(index);\r
 159         _userColourSchemeList.removeElementAt(index);\r
 160         return (jalview.binding.UserColourScheme) obj;\r
 161     } //-- jalview.binding.UserColourScheme removeUserColourScheme(int) \r
 162 \r
 163     /**\r
 164      * Method setUserColourScheme\r
 165      * \r
 166      * \r
 167      * \r
 168      * @param index\r
 169      * @param vUserColourScheme\r
 170      */\r
 171     public void setUserColourScheme(int index, jalview.binding.UserColourScheme vUserColourScheme)\r
 172         throws java.lang.IndexOutOfBoundsException\r
 173     {\r
 174         //-- check bounds for index\r
 175         if ((index < 0) || (index > _userColourSchemeList.size())) {\r
 176             throw new IndexOutOfBoundsException();\r
 177         }\r
 178         _userColourSchemeList.setElementAt(vUserColourScheme, index);\r
 179     } //-- void setUserColourScheme(int, jalview.binding.UserColourScheme) \r
 180 \r
 181     /**\r
 182      * Method setUserColourScheme\r
 183      * \r
 184      * \r
 185      * \r
 186      * @param userColourSchemeArray\r
 187      */\r
 188     public void setUserColourScheme(jalview.binding.UserColourScheme[] userColourSchemeArray)\r
 189     {\r
 190         //-- copy array\r
 191         _userColourSchemeList.removeAllElements();\r
 192         for (int i = 0; i < userColourSchemeArray.length; i++) {\r
 193             _userColourSchemeList.addElement(userColourSchemeArray[i]);\r
 194         }\r
 195     } //-- void setUserColourScheme(jalview.binding.UserColourScheme) \r
 196 \r
 197 }\r