/*\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 (Development Version 2.4.1)\r
+ * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ * \r
+ * This program 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 2\r
+ * of the License, or (at your option) any later version.\r
+ * \r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program; if not, write to the Free Software\r
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\r
*/\r
-\r
package jalview.schemabinding.version2;\r
\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
\r
/**\r
- * Field _structureStateList\r
+ * Field _structureStateList.\r
*/\r
private java.util.Vector _structureStateList;\r
\r
\r
public Pdbids() {\r
super();\r
- _structureStateList = new Vector();\r
- } //-- jalview.schemabinding.version2.Pdbids()\r
+ this._structureStateList = new java.util.Vector();\r
+ }\r
\r
\r
//-----------/\r
//-----------/\r
\r
/**\r
- * Method addStructureState\r
- * \r
* \r
* \r
* @param vStructureState\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
*/\r
- public void addStructureState(jalview.schemabinding.version2.StructureState vStructureState)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- _structureStateList.addElement(vStructureState);\r
- } //-- void addStructureState(jalview.schemabinding.version2.StructureState) \r
+ public void addStructureState(\r
+ final jalview.schemabinding.version2.StructureState vStructureState)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._structureStateList.addElement(vStructureState);\r
+ }\r
\r
/**\r
- * Method addStructureState\r
- * \r
* \r
* \r
* @param index\r
* @param vStructureState\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\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
+ public void addStructureState(\r
+ final int index,\r
+ final jalview.schemabinding.version2.StructureState vStructureState)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._structureStateList.add(index, vStructureState);\r
+ }\r
\r
/**\r
- * Method enumerateStructureState\r
- * \r
+ * Method enumerateStructureState.\r
* \r
- * \r
- * @return Enumeration\r
+ * @return an Enumeration over all\r
+ * jalview.schemabinding.version2.StructureState elements\r
*/\r
- public java.util.Enumeration enumerateStructureState()\r
- {\r
- return _structureStateList.elements();\r
- } //-- java.util.Enumeration enumerateStructureState() \r
+ public java.util.Enumeration enumerateStructureState(\r
+ ) {\r
+ return this._structureStateList.elements();\r
+ }\r
\r
/**\r
- * Method getStructureState\r
- * \r
- * \r
+ * Method getStructureState.\r
* \r
* @param index\r
- * @return StructureState\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ * @return the value of the\r
+ * jalview.schemabinding.version2.StructureState at the given\r
+ * index\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
+ public jalview.schemabinding.version2.StructureState getStructureState(\r
+ final int index)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._structureStateList.size()) {\r
+ throw new IndexOutOfBoundsException("getStructureState: Index value '" + index + "' not in range [0.." + (this._structureStateList.size() - 1) + "]");\r
}\r
\r
- return (jalview.schemabinding.version2.StructureState) _structureStateList.elementAt(index);\r
- } //-- jalview.schemabinding.version2.StructureState getStructureState(int) \r
+ return (jalview.schemabinding.version2.StructureState) _structureStateList.get(index);\r
+ }\r
\r
/**\r
- * Method getStructureState\r
- * \r
- * \r
- * \r
- * @return StructureState\r
+ * Method getStructureState.Returns the contents of the\r
+ * collection in an Array. <p>Note: Just in case the\r
+ * collection contents are changing in another thread, we pass\r
+ * a 0-length Array of the correct type into the API call. \r
+ * This way we <i>know</i> that the Array returned is of\r
+ * exactly the correct length.\r
+ * \r
+ * @return this collection as an Array\r
*/\r
- public jalview.schemabinding.version2.StructureState[] getStructureState()\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
+ 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.toArray(array);\r
+ }\r
\r
/**\r
- * Method getStructureStateCount\r
+ * Method getStructureStateCount.\r
* \r
- * \r
- * \r
- * @return int\r
+ * @return the size of this collection\r
*/\r
- public int getStructureStateCount()\r
- {\r
- return _structureStateList.size();\r
- } //-- int getStructureStateCount() \r
+ public int getStructureStateCount(\r
+ ) {\r
+ return this._structureStateList.size();\r
+ }\r
\r
/**\r
- * Method isValid\r
- * \r
- * \r
+ * Method isValid.\r
* \r
- * @return boolean\r
+ * @return true if this object is valid according to the schema\r
*/\r
- public boolean isValid()\r
- {\r
+ public boolean isValid(\r
+ ) {\r
try {\r
validate();\r
- }\r
- catch (org.exolab.castor.xml.ValidationException vex) {\r
+ } catch (org.exolab.castor.xml.ValidationException vex) {\r
return false;\r
}\r
return true;\r
- } //-- boolean isValid() \r
+ }\r
\r
/**\r
- * Method marshal\r
- * \r
* \r
* \r
* @param out\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
*/\r
- public void marshal(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\r
- \r
+ public void marshal(\r
+ final java.io.Writer out)\r
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
Marshaller.marshal(this, out);\r
- } //-- void marshal(java.io.Writer) \r
+ }\r
\r
/**\r
- * Method marshal\r
- * \r
* \r
* \r
* @param handler\r
+ * @throws java.io.IOException if an IOException occurs during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\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
+ public void marshal(\r
+ final org.xml.sax.ContentHandler handler)\r
+ throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
Marshaller.marshal(this, handler);\r
- } //-- void marshal(org.xml.sax.ContentHandler) \r
+ }\r
\r
/**\r
- * Method removeAllStructureState\r
- * \r
*/\r
- public void removeAllStructureState()\r
- {\r
- _structureStateList.removeAllElements();\r
- } //-- void removeAllStructureState() \r
+ public void removeAllStructureState(\r
+ ) {\r
+ this._structureStateList.clear();\r
+ }\r
\r
/**\r
- * Method removeStructureState\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
+ boolean removed = _structureStateList.remove(vStructureState);\r
+ return removed;\r
+ }\r
+\r
+ /**\r
+ * Method removeStructureStateAt.\r
* \r
* @param index\r
- * @return StructureState\r
+ * @return the element removed from the collection\r
*/\r
- public jalview.schemabinding.version2.StructureState removeStructureState(int index)\r
- {\r
- java.lang.Object obj = _structureStateList.elementAt(index);\r
- _structureStateList.removeElementAt(index);\r
+ public jalview.schemabinding.version2.StructureState removeStructureStateAt(\r
+ final int index) {\r
+ java.lang.Object obj = this._structureStateList.remove(index);\r
return (jalview.schemabinding.version2.StructureState) obj;\r
- } //-- jalview.schemabinding.version2.StructureState removeStructureState(int) \r
+ }\r
\r
/**\r
- * Method setStructureState\r
- * \r
* \r
* \r
* @param index\r
* @param vStructureState\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
*/\r
- public void setStructureState(int index, jalview.schemabinding.version2.StructureState vStructureState)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- //-- check bounds for index\r
- if ((index < 0) || (index > _structureStateList.size())) {\r
- throw new IndexOutOfBoundsException();\r
+ public void setStructureState(\r
+ final int index,\r
+ final jalview.schemabinding.version2.StructureState vStructureState)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._structureStateList.size()) {\r
+ throw new IndexOutOfBoundsException("setStructureState: Index value '" + index + "' not in range [0.." + (this._structureStateList.size() - 1) + "]");\r
}\r
- _structureStateList.setElementAt(vStructureState, index);\r
- } //-- void setStructureState(int, jalview.schemabinding.version2.StructureState) \r
+ \r
+ this._structureStateList.set(index, vStructureState);\r
+ }\r
\r
/**\r
- * Method setStructureState\r
- * \r
* \r
* \r
- * @param structureStateArray\r
+ * @param vStructureStateArray\r
*/\r
- public void setStructureState(jalview.schemabinding.version2.StructureState[] structureStateArray)\r
- {\r
+ public void setStructureState(\r
+ final jalview.schemabinding.version2.StructureState[] vStructureStateArray) {\r
//-- copy array\r
- _structureStateList.removeAllElements();\r
- for (int i = 0; i < structureStateArray.length; i++) {\r
- _structureStateList.addElement(structureStateArray[i]);\r
+ _structureStateList.clear();\r
+ \r
+ for (int i = 0; i < vStructureStateArray.length; i++) {\r
+ this._structureStateList.add(vStructureStateArray[i]);\r
}\r
- } //-- void setStructureState(jalview.schemabinding.version2.StructureState) \r
+ }\r
\r
/**\r
- * Method unmarshal\r
- * \r
- * \r
+ * Method unmarshal.\r
* \r
* @param reader\r
- * @return Object\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ * @return the unmarshaled\r
+ * jalview.schemabinding.version2.Pdbentry\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
+ public static jalview.schemabinding.version2.Pdbentry unmarshal(\r
+ final java.io.Reader reader)\r
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+ return (jalview.schemabinding.version2.Pdbentry) Unmarshaller.unmarshal(jalview.schemabinding.version2.Pdbids.class, reader);\r
+ }\r
\r
/**\r
- * Method validate\r
* \r
+ * \r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
*/\r
- public void validate()\r
- throws org.exolab.castor.xml.ValidationException\r
- {\r
+ public void validate(\r
+ )\r
+ throws org.exolab.castor.xml.ValidationException {\r
org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
validator.validate(this);\r
- } //-- void validate() \r
+ }\r
\r
}\r
git://source.jalview.org / jalview.git / blobdiff