Merge branch 'feature/JAL-3063JAXB' into feature/JAL-3063jaxbNoCastor
[jalview.git] / src / jalview / binding / Pdbentry.java
old mode 100755 (executable)
new mode 100644 (file)
index 7e0ae30..77bb446
-/*\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.binding;\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 Pdbentry.\r
- * \r
- * @version $Revision$ $Date$\r
- */\r
-public class Pdbentry 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 _items\r
-     */\r
-    private java.util.Vector _items;\r
-\r
-\r
-      //----------------/\r
-     //- Constructors -/\r
-    //----------------/\r
-\r
-    public Pdbentry() {\r
-        super();\r
-        _items = new Vector();\r
-    } //-- jalview.binding.Pdbentry()\r
-\r
-\r
-      //-----------/\r
-     //- Methods -/\r
-    //-----------/\r
-\r
-    /**\r
-     * Method addPdbentryItem\r
-     * \r
-     * \r
-     * \r
-     * @param vPdbentryItem\r
-     */\r
-    public void addPdbentryItem(jalview.binding.PdbentryItem vPdbentryItem)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        _items.addElement(vPdbentryItem);\r
-    } //-- void addPdbentryItem(jalview.binding.PdbentryItem) \r
-\r
-    /**\r
-     * Method addPdbentryItem\r
-     * \r
-     * \r
-     * \r
-     * @param index\r
-     * @param vPdbentryItem\r
-     */\r
-    public void addPdbentryItem(int index, jalview.binding.PdbentryItem vPdbentryItem)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        _items.insertElementAt(vPdbentryItem, index);\r
-    } //-- void addPdbentryItem(int, jalview.binding.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 '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.binding.PdbentryItem getPdbentryItem(int index)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        //-- check bounds for index\r
-        if ((index < 0) || (index > _items.size())) {\r
-            throw new IndexOutOfBoundsException();\r
-        }\r
-        \r
-        return (jalview.binding.PdbentryItem) _items.elementAt(index);\r
-    } //-- jalview.binding.PdbentryItem getPdbentryItem(int) \r
-\r
-    /**\r
-     * Method getPdbentryItem\r
-     * \r
-     * \r
-     * \r
-     * @return PdbentryItem\r
-     */\r
-    public jalview.binding.PdbentryItem[] getPdbentryItem()\r
-    {\r
-        int size = _items.size();\r
-        jalview.binding.PdbentryItem[] mArray = new jalview.binding.PdbentryItem[size];\r
-        for (int index = 0; index < size; index++) {\r
-            mArray[index] = (jalview.binding.PdbentryItem) _items.elementAt(index);\r
-        }\r
-        return mArray;\r
-    } //-- jalview.binding.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
-            validate();\r
-        }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\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, 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, 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.binding.PdbentryItem removePdbentryItem(int index)\r
-    {\r
-        java.lang.Object obj = _items.elementAt(index);\r
-        _items.removeElementAt(index);\r
-        return (jalview.binding.PdbentryItem) obj;\r
-    } //-- jalview.binding.PdbentryItem removePdbentryItem(int) \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, jalview.binding.PdbentryItem vPdbentryItem)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        //-- check bounds for index\r
-        if ((index < 0) || (index > _items.size())) {\r
-            throw new IndexOutOfBoundsException();\r
-        }\r
-        _items.setElementAt(vPdbentryItem, index);\r
-    } //-- void setPdbentryItem(int, jalview.binding.PdbentryItem) \r
-\r
-    /**\r
-     * Method setPdbentryItem\r
-     * \r
-     * \r
-     * \r
-     * @param pdbentryItemArray\r
-     */\r
-    public void setPdbentryItem(jalview.binding.PdbentryItem[] pdbentryItemArray)\r
-    {\r
-        //-- copy array\r
-        _items.removeAllElements();\r
-        for (int i = 0; i < pdbentryItemArray.length; i++) {\r
-            _items.addElement(pdbentryItemArray[i]);\r
-        }\r
-    } //-- void setPdbentryItem(jalview.binding.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, org.exolab.castor.xml.ValidationException\r
-    {\r
-        return (jalview.binding.Pdbentry) Unmarshaller.unmarshal(jalview.binding.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.Validator();\r
-        validator.validate(this);\r
-    } //-- void validate() \r
-\r
-}\r
+/*
+ * This class was automatically generated with 
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
+ * Schema.
+ * $Id$
+ */
+
+package jalview.binding;
+
+//---------------------------------/
+//- 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 _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.binding.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.binding.PdbentryItem vPdbentryItem)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    this._items.add(index, vPdbentryItem);
+  }
+
+  /**
+   * Method enumeratePdbentryItem.
+   * 
+   * @return an Enumeration over all jalview.binding.PdbentryItem elements
+   */
+  public java.util.Enumeration enumeratePdbentryItem()
+  {
+    return this._items.elements();
+  }
+
+  /**
+   * 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.binding.PdbentryItem at the given index
+   */
+  public jalview.binding.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.binding.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.binding.PdbentryItem[] getPdbentryItem()
+  {
+    jalview.binding.PdbentryItem[] array = new jalview.binding.PdbentryItem[0];
+    return (jalview.binding.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.binding.PdbentryItem vPdbentryItem)
+  {
+    boolean removed = _items.remove(vPdbentryItem);
+    return removed;
+  }
+
+  /**
+   * Method removePdbentryItemAt.
+   * 
+   * @param index
+   * @return the element removed from the collection
+   */
+  public jalview.binding.PdbentryItem removePdbentryItemAt(final int index)
+  {
+    java.lang.Object obj = this._items.remove(index);
+    return (jalview.binding.PdbentryItem) obj;
+  }
+
+  /**
+   * 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.binding.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.binding.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.binding.Pdbentry
+   */
+  public static jalview.binding.Pdbentry unmarshal(
+          final java.io.Reader reader)
+          throws org.exolab.castor.xml.MarshalException,
+          org.exolab.castor.xml.ValidationException
+  {
+    return (jalview.binding.Pdbentry) Unmarshaller
+            .unmarshal(jalview.binding.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);
+  }
+
+}