update author list in license for (JAL-826)
[jalview.git] / src / jalview / schemabinding / version2 / Pdbentry.java
old mode 100755 (executable)
new mode 100644 (file)
index f4fa4fe..c34fd73
-/*\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
- */\r
-\r
-package jalview.schemabinding.version2;\r
-\r
-//---------------------------------/\r
-//- Imported classes and packages -/\r
-//---------------------------------/\r
-\r
-import java.util.*;\r
-\r
-import org.exolab.castor.xml.*;\r
-\r
-/**\r
- * Class Pdbentry.\r
- *\r
- * @version $Revision$ $Date$\r
- */\r
-public class Pdbentry\r
-    implements java.io.Serializable\r
-{\r
-\r
-  //--------------------------/\r
-  //- Class/Member Variables -/\r
-  //--------------------------/\r
-\r
-  /**\r
-   * Field _id\r
-   */\r
-  private java.lang.String _id;\r
-\r
-  /**\r
-   * Field _type\r
-   */\r
-  private java.lang.String _type;\r
-\r
-  /**\r
-   * Field _file\r
-   */\r
-  private java.lang.String _file;\r
-\r
-  /**\r
-   * Field _items\r
-   */\r
-  private java.util.Vector _items;\r
-\r
-  //----------------/\r
-  //- Constructors -/\r
-  //----------------/\r
-\r
-  public Pdbentry()\r
-  {\r
-    super();\r
-    _items = new Vector();\r
-  } //-- jalview.schemabinding.version2.Pdbentry()\r
-\r
-  //-----------/\r
-  //- Methods -/\r
-  //-----------/\r
-\r
-  /**\r
-   * Method addPdbentryItem\r
-   *\r
-   *\r
-   *\r
-   * @param vPdbentryItem\r
-   */\r
-  public void addPdbentryItem(jalview.schemabinding.version2.PdbentryItem\r
-                              vPdbentryItem)\r
-      throws java.lang.IndexOutOfBoundsException\r
-  {\r
-    _items.addElement(vPdbentryItem);\r
-  } //-- void addPdbentryItem(jalview.schemabinding.version2.PdbentryItem)\r
-\r
-  /**\r
-   * Method addPdbentryItem\r
-   *\r
-   *\r
-   *\r
-   * @param index\r
-   * @param vPdbentryItem\r
-   */\r
-  public void addPdbentryItem(int index,\r
-                              jalview.schemabinding.version2.PdbentryItem\r
-                              vPdbentryItem)\r
-      throws java.lang.IndexOutOfBoundsException\r
-  {\r
-    _items.insertElementAt(vPdbentryItem, index);\r
-  } //-- void addPdbentryItem(int, jalview.schemabinding.version2.PdbentryItem)\r
-\r
-  /**\r
-   * Method enumeratePdbentryItem\r
-   *\r
-   *\r
-   *\r
-   * @return Enumeration\r
-   */\r
-  public java.util.Enumeration enumeratePdbentryItem()\r
-  {\r
-    return _items.elements();\r
-  } //-- java.util.Enumeration enumeratePdbentryItem()\r
-\r
-  /**\r
-   * Returns the value of field 'file'.\r
-   *\r
-   * @return String\r
-   * @return the value of field 'file'.\r
-   */\r
-  public java.lang.String getFile()\r
-  {\r
-    return this._file;\r
-  } //-- java.lang.String getFile()\r
-\r
-  /**\r
-   * Returns the value of field 'id'.\r
-   *\r
-   * @return String\r
-   * @return the value of field 'id'.\r
-   */\r
-  public java.lang.String getId()\r
-  {\r
-    return this._id;\r
-  } //-- java.lang.String getId()\r
-\r
-  /**\r
-   * Method getPdbentryItem\r
-   *\r
-   *\r
-   *\r
-   * @param index\r
-   * @return PdbentryItem\r
-   */\r
-  public jalview.schemabinding.version2.PdbentryItem getPdbentryItem(int index)\r
-      throws java.lang.IndexOutOfBoundsException\r
-  {\r
-    //-- check bounds for index\r
-    if ( (index < 0) || (index > _items.size()))\r
-    {\r
-      throw new IndexOutOfBoundsException();\r
-    }\r
-\r
-    return (jalview.schemabinding.version2.PdbentryItem) _items.elementAt(index);\r
-  } //-- jalview.schemabinding.version2.PdbentryItem getPdbentryItem(int)\r
-\r
-  /**\r
-   * Method getPdbentryItem\r
-   *\r
-   *\r
-   *\r
-   * @return PdbentryItem\r
-   */\r
-  public jalview.schemabinding.version2.PdbentryItem[] getPdbentryItem()\r
-  {\r
-    int size = _items.size();\r
-    jalview.schemabinding.version2.PdbentryItem[] mArray = new jalview.\r
-        schemabinding.version2.PdbentryItem[size];\r
-    for (int index = 0; index < size; index++)\r
-    {\r
-      mArray[index] = (jalview.schemabinding.version2.PdbentryItem) _items.\r
-          elementAt(index);\r
-    }\r
-    return mArray;\r
-  } //-- jalview.schemabinding.version2.PdbentryItem[] getPdbentryItem()\r
-\r
-  /**\r
-   * Method getPdbentryItemCount\r
-   *\r
-   *\r
-   *\r
-   * @return int\r
-   */\r
-  public int getPdbentryItemCount()\r
-  {\r
-    return _items.size();\r
-  } //-- int getPdbentryItemCount()\r
-\r
-  /**\r
-   * Returns the value of field 'type'.\r
-   *\r
-   * @return String\r
-   * @return the value of field 'type'.\r
-   */\r
-  public java.lang.String getType()\r
-  {\r
-    return this._type;\r
-  } //-- java.lang.String getType()\r
-\r
-  /**\r
-   * Method isValid\r
-   *\r
-   *\r
-   *\r
-   * @return boolean\r
-   */\r
-  public boolean isValid()\r
-  {\r
-    try\r
-    {\r
-      validate();\r
-    }\r
-    catch (org.exolab.castor.xml.ValidationException vex)\r
-    {\r
-      return false;\r
-    }\r
-    return true;\r
-  } //-- boolean isValid()\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,\r
-      org.exolab.castor.xml.ValidationException\r
-  {\r
-\r
-    Marshaller.marshal(this, out);\r
-  } //-- void marshal(java.io.Writer)\r
-\r
-  /**\r
-   * Method marshal\r
-   *\r
-   *\r
-   *\r
-   * @param handler\r
-   */\r
-  public void marshal(org.xml.sax.ContentHandler handler)\r
-      throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
-      org.exolab.castor.xml.ValidationException\r
-  {\r
-\r
-    Marshaller.marshal(this, handler);\r
-  } //-- void marshal(org.xml.sax.ContentHandler)\r
-\r
-  /**\r
-   * Method removeAllPdbentryItem\r
-   *\r
-   */\r
-  public void removeAllPdbentryItem()\r
-  {\r
-    _items.removeAllElements();\r
-  } //-- void removeAllPdbentryItem()\r
-\r
-  /**\r
-   * Method removePdbentryItem\r
-   *\r
-   *\r
-   *\r
-   * @param index\r
-   * @return PdbentryItem\r
-   */\r
-  public jalview.schemabinding.version2.PdbentryItem removePdbentryItem(int\r
-      index)\r
-  {\r
-    java.lang.Object obj = _items.elementAt(index);\r
-    _items.removeElementAt(index);\r
-    return (jalview.schemabinding.version2.PdbentryItem) obj;\r
-  } //-- jalview.schemabinding.version2.PdbentryItem removePdbentryItem(int)\r
-\r
-  /**\r
-   * Sets the value of field 'file'.\r
-   *\r
-   * @param file the value of field 'file'.\r
-   */\r
-  public void setFile(java.lang.String file)\r
-  {\r
-    this._file = file;\r
-  } //-- void setFile(java.lang.String)\r
-\r
-  /**\r
-   * Sets the value of field 'id'.\r
-   *\r
-   * @param id the value of field 'id'.\r
-   */\r
-  public void setId(java.lang.String id)\r
-  {\r
-    this._id = id;\r
-  } //-- void setId(java.lang.String)\r
-\r
-  /**\r
-   * Method setPdbentryItem\r
-   *\r
-   *\r
-   *\r
-   * @param index\r
-   * @param vPdbentryItem\r
-   */\r
-  public void setPdbentryItem(int index,\r
-                              jalview.schemabinding.version2.PdbentryItem\r
-                              vPdbentryItem)\r
-      throws java.lang.IndexOutOfBoundsException\r
-  {\r
-    //-- check bounds for index\r
-    if ( (index < 0) || (index > _items.size()))\r
-    {\r
-      throw new IndexOutOfBoundsException();\r
-    }\r
-    _items.setElementAt(vPdbentryItem, index);\r
-  } //-- void setPdbentryItem(int, jalview.schemabinding.version2.PdbentryItem)\r
-\r
-  /**\r
-   * Method setPdbentryItem\r
-   *\r
-   *\r
-   *\r
-   * @param pdbentryItemArray\r
-   */\r
-  public void setPdbentryItem(jalview.schemabinding.version2.PdbentryItem[]\r
-                              pdbentryItemArray)\r
-  {\r
-    //-- copy array\r
-    _items.removeAllElements();\r
-    for (int i = 0; i < pdbentryItemArray.length; i++)\r
-    {\r
-      _items.addElement(pdbentryItemArray[i]);\r
-    }\r
-  } //-- void setPdbentryItem(jalview.schemabinding.version2.PdbentryItem)\r
-\r
-  /**\r
-   * Sets the value of field 'type'.\r
-   *\r
-   * @param type the value of field 'type'.\r
-   */\r
-  public void setType(java.lang.String type)\r
-  {\r
-    this._type = type;\r
-  } //-- void setType(java.lang.String)\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,\r
-      org.exolab.castor.xml.ValidationException\r
-  {\r
-    return (jalview.schemabinding.version2.Pdbentry) Unmarshaller.unmarshal(\r
-        jalview.schemabinding.version2.Pdbentry.class, reader);\r
-  } //-- java.lang.Object unmarshal(java.io.Reader)\r
-\r
-  /**\r
-   * Method validate\r
-   *\r
-   */\r
-  public void validate()\r
-      throws org.exolab.castor.xml.ValidationException\r
-  {\r
-    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
-        Validator();\r
-    validator.validate(this);\r
-  } //-- void validate()\r
-\r
-}\r
+/*******************************************************************************
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ *******************************************************************************/
+/*
+ * This class was automatically generated with 
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
+ * Schema.
+ * $Id$
+ */
+
+package jalview.schemabinding.version2;
+
+  //---------------------------------/
+ //- Imported classes and packages -/
+//---------------------------------/
+
+import org.exolab.castor.xml.Marshaller;
+import org.exolab.castor.xml.Unmarshaller;
+
+/**
+ * Class Pdbentry.
+ * 
+ * @version $Revision$ $Date$
+ */
+public class Pdbentry implements java.io.Serializable {
+
+
+      //--------------------------/
+     //- Class/Member Variables -/
+    //--------------------------/
+
+    /**
+     * Field _id.
+     */
+    private java.lang.String _id;
+
+    /**
+     * Field _type.
+     */
+    private java.lang.String _type;
+
+    /**
+     * Field _file.
+     */
+    private java.lang.String _file;
+
+    /**
+     * Field _items.
+     */
+    private java.util.Vector _items;
+
+
+      //----------------/
+     //- Constructors -/
+    //----------------/
+
+    public Pdbentry() {
+        super();
+        this._items = new java.util.Vector();
+    }
+
+
+      //-----------/
+     //- Methods -/
+    //-----------/
+
+    /**
+     * 
+     * 
+     * @param vPdbentryItem
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     */
+    public void addPdbentryItem(
+            final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)
+    throws java.lang.IndexOutOfBoundsException {
+        this._items.addElement(vPdbentryItem);
+    }
+
+    /**
+     * 
+     * 
+     * @param index
+     * @param vPdbentryItem
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     */
+    public void addPdbentryItem(
+            final int index,
+            final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)
+    throws java.lang.IndexOutOfBoundsException {
+        this._items.add(index, vPdbentryItem);
+    }
+
+    /**
+     * Method enumeratePdbentryItem.
+     * 
+     * @return an Enumeration over all
+     * jalview.schemabinding.version2.PdbentryItem elements
+     */
+    public java.util.Enumeration enumeratePdbentryItem(
+    ) {
+        return this._items.elements();
+    }
+
+    /**
+     * Returns the value of field 'file'.
+     * 
+     * @return the value of field 'File'.
+     */
+    public java.lang.String getFile(
+    ) {
+        return this._file;
+    }
+
+    /**
+     * Returns the value of field 'id'.
+     * 
+     * @return the value of field 'Id'.
+     */
+    public java.lang.String getId(
+    ) {
+        return this._id;
+    }
+
+    /**
+     * Method getPdbentryItem.
+     * 
+     * @param index
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     * @return the value of the
+     * jalview.schemabinding.version2.PdbentryItem at the given inde
+     */
+    public jalview.schemabinding.version2.PdbentryItem getPdbentryItem(
+            final int index)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._items.size()) {
+            throw new IndexOutOfBoundsException("getPdbentryItem: Index value '" + index + "' not in range [0.." + (this._items.size() - 1) + "]");
+        }
+        
+        return (jalview.schemabinding.version2.PdbentryItem) _items.get(index);
+    }
+
+    /**
+     * Method getPdbentryItem.Returns the contents of the
+     * collection in an Array.  <p>Note:  Just in case the
+     * collection contents are changing in another thread, we pass
+     * a 0-length Array of the correct type into the API call. 
+     * This way we <i>know</i> that the Array returned is of
+     * exactly the correct length.
+     * 
+     * @return this collection as an Array
+     */
+    public jalview.schemabinding.version2.PdbentryItem[] getPdbentryItem(
+    ) {
+        jalview.schemabinding.version2.PdbentryItem[] array = new jalview.schemabinding.version2.PdbentryItem[0];
+        return (jalview.schemabinding.version2.PdbentryItem[]) this._items.toArray(array);
+    }
+
+    /**
+     * Method getPdbentryItemCount.
+     * 
+     * @return the size of this collection
+     */
+    public int getPdbentryItemCount(
+    ) {
+        return this._items.size();
+    }
+
+    /**
+     * Returns the value of field 'type'.
+     * 
+     * @return the value of field 'Type'.
+     */
+    public java.lang.String getType(
+    ) {
+        return this._type;
+    }
+
+    /**
+     * Method isValid.
+     * 
+     * @return true if this object is valid according to the schema
+     */
+    public boolean isValid(
+    ) {
+        try {
+            validate();
+        } catch (org.exolab.castor.xml.ValidationException vex) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * 
+     * 
+     * @param out
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     */
+    public void marshal(
+            final java.io.Writer out)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
+        Marshaller.marshal(this, out);
+    }
+
+    /**
+     * 
+     * 
+     * @param handler
+     * @throws java.io.IOException if an IOException occurs during
+     * marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
+     */
+    public void marshal(
+            final org.xml.sax.ContentHandler handler)
+    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
+        Marshaller.marshal(this, handler);
+    }
+
+    /**
+     */
+    public void removeAllPdbentryItem(
+    ) {
+        this._items.clear();
+    }
+
+    /**
+     * Method removePdbentryItem.
+     * 
+     * @param vPdbentryItem
+     * @return true if the object was removed from the collection.
+     */
+    public boolean removePdbentryItem(
+            final jalview.schemabinding.version2.PdbentryItem vPdbentryItem) {
+        boolean removed = _items.remove(vPdbentryItem);
+        return removed;
+    }
+
+    /**
+     * Method removePdbentryItemAt.
+     * 
+     * @param index
+     * @return the element removed from the collection
+     */
+    public jalview.schemabinding.version2.PdbentryItem removePdbentryItemAt(
+            final int index) {
+        java.lang.Object obj = this._items.remove(index);
+        return (jalview.schemabinding.version2.PdbentryItem) obj;
+    }
+
+    /**
+     * Sets the value of field 'file'.
+     * 
+     * @param file the value of field 'file'.
+     */
+    public void setFile(
+            final java.lang.String file) {
+        this._file = file;
+    }
+
+    /**
+     * Sets the value of field 'id'.
+     * 
+     * @param id the value of field 'id'.
+     */
+    public void setId(
+            final java.lang.String id) {
+        this._id = id;
+    }
+
+    /**
+     * 
+     * 
+     * @param index
+     * @param vPdbentryItem
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
+     */
+    public void setPdbentryItem(
+            final int index,
+            final jalview.schemabinding.version2.PdbentryItem vPdbentryItem)
+    throws java.lang.IndexOutOfBoundsException {
+        // check bounds for index
+        if (index < 0 || index >= this._items.size()) {
+            throw new IndexOutOfBoundsException("setPdbentryItem: Index value '" + index + "' not in range [0.." + (this._items.size() - 1) + "]");
+        }
+        
+        this._items.set(index, vPdbentryItem);
+    }
+
+    /**
+     * 
+     * 
+     * @param vPdbentryItemArray
+     */
+    public void setPdbentryItem(
+            final jalview.schemabinding.version2.PdbentryItem[] vPdbentryItemArray) {
+        //-- copy array
+        _items.clear();
+        
+        for (int i = 0; i < vPdbentryItemArray.length; i++) {
+                this._items.add(vPdbentryItemArray[i]);
+        }
+    }
+
+    /**
+     * Sets the value of field 'type'.
+     * 
+     * @param type the value of field 'type'.
+     */
+    public void setType(
+            final java.lang.String type) {
+        this._type = type;
+    }
+
+    /**
+     * Method unmarshal.
+     * 
+     * @param reader
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     * @return the unmarshaled
+     * jalview.schemabinding.version2.Pdbentry
+     */
+    public static jalview.schemabinding.version2.Pdbentry unmarshal(
+            final java.io.Reader reader)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
+        return (jalview.schemabinding.version2.Pdbentry) Unmarshaller.unmarshal(jalview.schemabinding.version2.Pdbentry.class, reader);
+    }
+
+    /**
+     * 
+     * 
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     */
+    public void validate(
+    )
+    throws org.exolab.castor.xml.ValidationException {
+        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
+        validator.validate(this);
+    }
+
+}