/*\r
- * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
+ * \r
+ * This file is part of Jalview.\r
+ * \r
+ * Jalview is free software: you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License \r
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
+ * \r
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE. See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.\r
*/\r
-\r
package jalview.schemabinding.version2;\r
\r
- //---------------------------------/\r
- //- Imported classes and packages -/\r
+//---------------------------------/\r
+//- Imported classes and packages -/\r
//---------------------------------/\r
\r
-import java.io.IOException;\r
-import java.io.Reader;\r
-import java.io.Serializable;\r
-import java.io.Writer;\r
-import java.util.Enumeration;\r
-import java.util.Vector;\r
-import org.exolab.castor.xml.MarshalException;\r
import org.exolab.castor.xml.Marshaller;\r
import org.exolab.castor.xml.Unmarshaller;\r
-import org.exolab.castor.xml.ValidationException;\r
-import org.xml.sax.ContentHandler;\r
\r
/**\r
* Class Pdbids.\r
* \r
* @version $Revision$ $Date$\r
*/\r
-public class Pdbids extends jalview.schemabinding.version2.Pdbentry \r
-implements java.io.Serializable\r
+public class Pdbids extends jalview.schemabinding.version2.Pdbentry\r
+ implements java.io.Serializable\r
{\r
\r
+ // --------------------------/\r
+ // - Class/Member Variables -/\r
+ // --------------------------/\r
\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
+ /**\r
+ * Field _structureStateList.\r
+ */\r
+ private java.util.Vector _structureStateList;\r
\r
- /**\r
- * Field _structureStateList\r
- */\r
- private java.util.Vector _structureStateList;\r
+ // ----------------/\r
+ // - Constructors -/\r
+ // ----------------/\r
\r
+ public Pdbids()\r
+ {\r
+ super();\r
+ this._structureStateList = new java.util.Vector();\r
+ }\r
\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
+ // -----------/\r
+ // - Methods -/\r
+ // -----------/\r
\r
- public Pdbids() {\r
- super();\r
- _structureStateList = new Vector();\r
- } //-- jalview.schemabinding.version2.Pdbids()\r
+ /**\r
+ * \r
+ * \r
+ * @param vStructureState\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ */\r
+ public void addStructureState(\r
+ final jalview.schemabinding.version2.StructureState vStructureState)\r
+ throws java.lang.IndexOutOfBoundsException\r
+ {\r
+ this._structureStateList.addElement(vStructureState);\r
+ }\r
\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vStructureState\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ */\r
+ public void addStructureState(\r
+ final int index,\r
+ final jalview.schemabinding.version2.StructureState vStructureState)\r
+ throws java.lang.IndexOutOfBoundsException\r
+ {\r
+ this._structureStateList.add(index, vStructureState);\r
+ }\r
\r
- //-----------/\r
- //- Methods -/\r
- //-----------/\r
+ /**\r
+ * Method enumerateStructureState.\r
+ * \r
+ * @return an Enumeration over all\r
+ * jalview.schemabinding.version2.StructureState elements\r
+ */\r
+ public java.util.Enumeration enumerateStructureState()\r
+ {\r
+ return this._structureStateList.elements();\r
+ }\r
\r
- /**\r
- * Method addStructureState\r
- * \r
- * \r
- * \r
- * @param vStructureState\r
- */\r
- public void addStructureState(jalview.schemabinding.version2.StructureState vStructureState)\r
- throws java.lang.IndexOutOfBoundsException\r
+ /**\r
+ * Method getStructureState.\r
+ * \r
+ * @param index\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ * @return the value of the jalview.schemabinding.version2.StructureState at\r
+ * the given index\r
+ */\r
+ public jalview.schemabinding.version2.StructureState getStructureState(\r
+ final int index) throws java.lang.IndexOutOfBoundsException\r
+ {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._structureStateList.size())\r
{\r
- _structureStateList.addElement(vStructureState);\r
- } //-- void addStructureState(jalview.schemabinding.version2.StructureState) \r
+ throw new IndexOutOfBoundsException(\r
+ "getStructureState: Index value '" + index\r
+ + "' not in range [0.."\r
+ + (this._structureStateList.size() - 1) + "]");\r
+ }\r
\r
- /**\r
- * Method addStructureState\r
- * \r
- * \r
- * \r
- * @param index\r
- * @param vStructureState\r
- */\r
- public void addStructureState(int index, jalview.schemabinding.version2.StructureState vStructureState)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- _structureStateList.insertElementAt(vStructureState, index);\r
- } //-- void addStructureState(int, jalview.schemabinding.version2.StructureState) \r
+ return (jalview.schemabinding.version2.StructureState) _structureStateList\r
+ .get(index);\r
+ }\r
\r
- /**\r
- * Method enumerateStructureState\r
- * \r
- * \r
- * \r
- * @return Enumeration\r
- */\r
- public java.util.Enumeration enumerateStructureState()\r
- {\r
- return _structureStateList.elements();\r
- } //-- java.util.Enumeration enumerateStructureState() \r
+ /**\r
+ * Method getStructureState.Returns the contents of the collection in an\r
+ * Array.\r
+ * <p>\r
+ * Note: Just in case the collection contents are changing in another thread,\r
+ * we pass a 0-length Array of the correct type into the API call. This way we\r
+ * <i>know</i> that the Array returned is of exactly the correct length.\r
+ * \r
+ * @return this collection as an Array\r
+ */\r
+ public jalview.schemabinding.version2.StructureState[] getStructureState()\r
+ {\r
+ jalview.schemabinding.version2.StructureState[] array = new jalview.schemabinding.version2.StructureState[0];\r
+ return (jalview.schemabinding.version2.StructureState[]) this._structureStateList\r
+ .toArray(array);\r
+ }\r
\r
- /**\r
- * Method getStructureState\r
- * \r
- * \r
- * \r
- * @param index\r
- * @return StructureState\r
- */\r
- public jalview.schemabinding.version2.StructureState getStructureState(int index)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- //-- check bounds for index\r
- if ((index < 0) || (index > _structureStateList.size())) {\r
- throw new IndexOutOfBoundsException();\r
- }\r
- \r
- return (jalview.schemabinding.version2.StructureState) _structureStateList.elementAt(index);\r
- } //-- jalview.schemabinding.version2.StructureState getStructureState(int) \r
+ /**\r
+ * Method getStructureStateCount.\r
+ * \r
+ * @return the size of this collection\r
+ */\r
+ public int getStructureStateCount()\r
+ {\r
+ return this._structureStateList.size();\r
+ }\r
\r
- /**\r
- * Method getStructureState\r
- * \r
- * \r
- * \r
- * @return StructureState\r
- */\r
- public jalview.schemabinding.version2.StructureState[] getStructureState()\r
+ /**\r
+ * Method isValid.\r
+ * \r
+ * @return true if this object is valid according to the schema\r
+ */\r
+ public boolean isValid()\r
+ {\r
+ try\r
{\r
- int size = _structureStateList.size();\r
- jalview.schemabinding.version2.StructureState[] mArray = new jalview.schemabinding.version2.StructureState[size];\r
- for (int index = 0; index < size; index++) {\r
- mArray[index] = (jalview.schemabinding.version2.StructureState) _structureStateList.elementAt(index);\r
- }\r
- return mArray;\r
- } //-- jalview.schemabinding.version2.StructureState[] getStructureState() \r
-\r
- /**\r
- * Method getStructureStateCount\r
- * \r
- * \r
- * \r
- * @return int\r
- */\r
- public int getStructureStateCount()\r
+ validate();\r
+ } catch (org.exolab.castor.xml.ValidationException vex)\r
{\r
- return _structureStateList.size();\r
- } //-- int getStructureStateCount() \r
+ return false;\r
+ }\r
+ return true;\r
+ }\r
\r
- /**\r
- * Method isValid\r
- * \r
- * \r
- * \r
- * @return boolean\r
- */\r
- public boolean isValid()\r
- {\r
- try {\r
- validate();\r
- }\r
- catch (org.exolab.castor.xml.ValidationException vex) {\r
- return false;\r
- }\r
- return true;\r
- } //-- boolean isValid() \r
+ /**\r
+ * \r
+ * \r
+ * @param out\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ */\r
+ public void marshal(final java.io.Writer out)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
+ {\r
+ Marshaller.marshal(this, out);\r
+ }\r
\r
- /**\r
- * Method marshal\r
- * \r
- * \r
- * \r
- * @param out\r
- */\r
- public void marshal(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\r
- \r
- Marshaller.marshal(this, out);\r
- } //-- void marshal(java.io.Writer) \r
+ /**\r
+ * \r
+ * \r
+ * @param handler\r
+ * @throws java.io.IOException\r
+ * if an IOException occurs during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ */\r
+ public void marshal(final org.xml.sax.ContentHandler handler)\r
+ throws java.io.IOException,\r
+ org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
+ {\r
+ Marshaller.marshal(this, handler);\r
+ }\r
\r
- /**\r
- * Method marshal\r
- * \r
- * \r
- * \r
- * @param handler\r
+ /**\r
*/\r
- public void marshal(org.xml.sax.ContentHandler handler)\r
- throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\r
- \r
- Marshaller.marshal(this, handler);\r
- } //-- void marshal(org.xml.sax.ContentHandler) \r
+ public void removeAllStructureState()\r
+ {\r
+ this._structureStateList.clear();\r
+ }\r
\r
- /**\r
- * Method removeAllStructureState\r
- * \r
- */\r
- public void removeAllStructureState()\r
- {\r
- _structureStateList.removeAllElements();\r
- } //-- void removeAllStructureState() \r
+ /**\r
+ * Method removeStructureState.\r
+ * \r
+ * @param vStructureState\r
+ * @return true if the object was removed from the collection.\r
+ */\r
+ public boolean removeStructureState(\r
+ final jalview.schemabinding.version2.StructureState vStructureState)\r
+ {\r
+ boolean removed = _structureStateList.remove(vStructureState);\r
+ return removed;\r
+ }\r
\r
- /**\r
- * Method removeStructureState\r
- * \r
- * \r
- * \r
- * @param index\r
- * @return StructureState\r
- */\r
- public jalview.schemabinding.version2.StructureState removeStructureState(int index)\r
- {\r
- java.lang.Object obj = _structureStateList.elementAt(index);\r
- _structureStateList.removeElementAt(index);\r
- return (jalview.schemabinding.version2.StructureState) obj;\r
- } //-- jalview.schemabinding.version2.StructureState removeStructureState(int) \r
+ /**\r
+ * Method removeStructureStateAt.\r
+ * \r
+ * @param index\r
+ * @return the element removed from the collection\r
+ */\r
+ public jalview.schemabinding.version2.StructureState removeStructureStateAt(\r
+ final int index)\r
+ {\r
+ java.lang.Object obj = this._structureStateList.remove(index);\r
+ return (jalview.schemabinding.version2.StructureState) obj;\r
+ }\r
\r
- /**\r
- * Method setStructureState\r
- * \r
- * \r
- * \r
- * @param index\r
- * @param vStructureState\r
- */\r
- public void setStructureState(int index, jalview.schemabinding.version2.StructureState vStructureState)\r
- throws java.lang.IndexOutOfBoundsException\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vStructureState\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ */\r
+ public void setStructureState(\r
+ final int index,\r
+ final jalview.schemabinding.version2.StructureState vStructureState)\r
+ throws java.lang.IndexOutOfBoundsException\r
+ {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._structureStateList.size())\r
{\r
- //-- check bounds for index\r
- if ((index < 0) || (index > _structureStateList.size())) {\r
- throw new IndexOutOfBoundsException();\r
- }\r
- _structureStateList.setElementAt(vStructureState, index);\r
- } //-- void setStructureState(int, jalview.schemabinding.version2.StructureState) \r
+ throw new IndexOutOfBoundsException(\r
+ "setStructureState: Index value '" + index\r
+ + "' not in range [0.."\r
+ + (this._structureStateList.size() - 1) + "]");\r
+ }\r
\r
- /**\r
- * Method setStructureState\r
- * \r
- * \r
- * \r
- * @param structureStateArray\r
- */\r
- public void setStructureState(jalview.schemabinding.version2.StructureState[] structureStateArray)\r
- {\r
- //-- copy array\r
- _structureStateList.removeAllElements();\r
- for (int i = 0; i < structureStateArray.length; i++) {\r
- _structureStateList.addElement(structureStateArray[i]);\r
- }\r
- } //-- void setStructureState(jalview.schemabinding.version2.StructureState) \r
+ this._structureStateList.set(index, vStructureState);\r
+ }\r
\r
- /**\r
- * Method unmarshal\r
- * \r
- * \r
- * \r
- * @param reader\r
- * @return Object\r
- */\r
- public static java.lang.Object unmarshal(java.io.Reader reader)\r
- throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\r
- return (jalview.schemabinding.version2.Pdbids) Unmarshaller.unmarshal(jalview.schemabinding.version2.Pdbids.class, reader);\r
- } //-- java.lang.Object unmarshal(java.io.Reader) \r
+ /**\r
+ * \r
+ * \r
+ * @param vStructureStateArray\r
+ */\r
+ public void setStructureState(\r
+ final jalview.schemabinding.version2.StructureState[] vStructureStateArray)\r
+ {\r
+ // -- copy array\r
+ _structureStateList.clear();\r
\r
- /**\r
- * Method validate\r
- * \r
- */\r
- public void validate()\r
- throws org.exolab.castor.xml.ValidationException\r
+ for (int i = 0; i < vStructureStateArray.length; i++)\r
{\r
- org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
- validator.validate(this);\r
- } //-- void validate() \r
+ this._structureStateList.add(vStructureStateArray[i]);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Method unmarshal.\r
+ * \r
+ * @param reader\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ * @return the unmarshaled jalview.schemabinding.version2.Pdbentry\r
+ */\r
+ public static jalview.schemabinding.version2.Pdbentry unmarshal(\r
+ final java.io.Reader reader)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
+ {\r
+ return (jalview.schemabinding.version2.Pdbentry) Unmarshaller\r
+ .unmarshal(jalview.schemabinding.version2.Pdbids.class, reader);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ */\r
+ public void validate() throws org.exolab.castor.xml.ValidationException\r
+ {\r
+ org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
+ validator.validate(this);\r
+ }\r
\r
}\r
git://source.jalview.org / jalview.git / blobdiff