Jalview 2.6 source licence
[jalview.git] / src / jalview / schemabinding / version2 / PdbentryItem.java
index 3dbc99c..9cd3c47 100755 (executable)
@@ -1,10 +1,20 @@
 /*\r
- * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\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
@@ -12,181 +22,193 @@ package jalview.schemabinding.version2;
  * \r
  * @version $Revision$ $Date$\r
  */\r
-public class PdbentryItem implements java.io.Serializable {\r
-\r
-\r
-      //--------------------------/\r
-     //- Class/Member Variables -/\r
-    //--------------------------/\r
-\r
-    /**\r
-     * Field _propertyList.\r
-     */\r
-    private java.util.Vector _propertyList;\r
-\r
-\r
-      //----------------/\r
-     //- Constructors -/\r
-    //----------------/\r
-\r
-    public PdbentryItem() {\r
-        super();\r
-        this._propertyList = new java.util.Vector();\r
-    }\r
-\r
-\r
-      //-----------/\r
-     //- Methods -/\r
-    //-----------/\r
-\r
-    /**\r
-     * \r
-     * \r
-     * @param vProperty\r
-     * @throws java.lang.IndexOutOfBoundsException if the index\r
-     * given is outside the bounds of the collection\r
-     */\r
-    public void addProperty(\r
-            final jalview.schemabinding.version2.Property vProperty)\r
-    throws java.lang.IndexOutOfBoundsException {\r
-        this._propertyList.addElement(vProperty);\r
-    }\r
-\r
-    /**\r
-     * \r
-     * \r
-     * @param index\r
-     * @param vProperty\r
-     * @throws java.lang.IndexOutOfBoundsException if the index\r
-     * given is outside the bounds of the collection\r
-     */\r
-    public void addProperty(\r
-            final int index,\r
-            final jalview.schemabinding.version2.Property vProperty)\r
-    throws java.lang.IndexOutOfBoundsException {\r
-        this._propertyList.add(index, vProperty);\r
-    }\r
-\r
-    /**\r
-     * Method enumerateProperty.\r
-     * \r
-     * @return an Enumeration over all\r
-     * jalview.schemabinding.version2.Property elements\r
-     */\r
-    public java.util.Enumeration enumerateProperty(\r
-    ) {\r
-        return this._propertyList.elements();\r
-    }\r
-\r
-    /**\r
-     * Method getProperty.\r
-     * \r
-     * @param index\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.Property at the given index\r
-     */\r
-    public jalview.schemabinding.version2.Property getProperty(\r
-            final int index)\r
-    throws java.lang.IndexOutOfBoundsException {\r
-        // check bounds for index\r
-        if (index < 0 || index >= this._propertyList.size()) {\r
-            throw new IndexOutOfBoundsException("getProperty: Index value '" + index + "' not in range [0.." + (this._propertyList.size() - 1) + "]");\r
-        }\r
-        \r
-        return (jalview.schemabinding.version2.Property) _propertyList.get(index);\r
-    }\r
-\r
-    /**\r
-     * Method getProperty.Returns the contents of the collection in\r
-     * an Array.  <p>Note:  Just in case the collection contents\r
-     * are changing in another thread, we pass a 0-length Array of\r
-     * the correct type into the API call.  This way we <i>know</i>\r
-     * that the Array returned is of exactly the correct length.\r
-     * \r
-     * @return this collection as an Array\r
-     */\r
-    public jalview.schemabinding.version2.Property[] getProperty(\r
-    ) {\r
-        jalview.schemabinding.version2.Property[] array = new jalview.schemabinding.version2.Property[0];\r
-        return (jalview.schemabinding.version2.Property[]) this._propertyList.toArray(array);\r
-    }\r
-\r
-    /**\r
-     * Method getPropertyCount.\r
-     * \r
-     * @return the size of this collection\r
-     */\r
-    public int getPropertyCount(\r
-    ) {\r
-        return this._propertyList.size();\r
+public class PdbentryItem implements java.io.Serializable\r
+{\r
+\r
+  // --------------------------/\r
+  // - Class/Member Variables -/\r
+  // --------------------------/\r
+\r
+  /**\r
+   * Field _propertyList.\r
+   */\r
+  private java.util.Vector _propertyList;\r
+\r
+  // ----------------/\r
+  // - Constructors -/\r
+  // ----------------/\r
+\r
+  public PdbentryItem()\r
+  {\r
+    super();\r
+    this._propertyList = new java.util.Vector();\r
+  }\r
+\r
+  // -----------/\r
+  // - Methods -/\r
+  // -----------/\r
+\r
+  /**\r
+   * \r
+   * \r
+   * @param vProperty\r
+   * @throws java.lang.IndexOutOfBoundsException\r
+   *           if the index given is outside the bounds of the collection\r
+   */\r
+  public void addProperty(\r
+          final jalview.schemabinding.version2.Property vProperty)\r
+          throws java.lang.IndexOutOfBoundsException\r
+  {\r
+    this._propertyList.addElement(vProperty);\r
+  }\r
+\r
+  /**\r
+   * \r
+   * \r
+   * @param index\r
+   * @param vProperty\r
+   * @throws java.lang.IndexOutOfBoundsException\r
+   *           if the index given is outside the bounds of the collection\r
+   */\r
+  public void addProperty(final int index,\r
+          final jalview.schemabinding.version2.Property vProperty)\r
+          throws java.lang.IndexOutOfBoundsException\r
+  {\r
+    this._propertyList.add(index, vProperty);\r
+  }\r
+\r
+  /**\r
+   * Method enumerateProperty.\r
+   * \r
+   * @return an Enumeration over all jalview.schemabinding.version2.Property\r
+   *         elements\r
+   */\r
+  public java.util.Enumeration enumerateProperty()\r
+  {\r
+    return this._propertyList.elements();\r
+  }\r
+\r
+  /**\r
+   * Method getProperty.\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.Property at the\r
+   *         given index\r
+   */\r
+  public jalview.schemabinding.version2.Property getProperty(final int index)\r
+          throws java.lang.IndexOutOfBoundsException\r
+  {\r
+    // check bounds for index\r
+    if (index < 0 || index >= this._propertyList.size())\r
+    {\r
+      throw new IndexOutOfBoundsException("getProperty: Index value '"\r
+              + index + "' not in range [0.."\r
+              + (this._propertyList.size() - 1) + "]");\r
     }\r
 \r
-    /**\r
+    return (jalview.schemabinding.version2.Property) _propertyList\r
+            .get(index);\r
+  }\r
+\r
+  /**\r
+   * Method getProperty.Returns the contents of the collection in an 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.Property[] getProperty()\r
+  {\r
+    jalview.schemabinding.version2.Property[] array = new jalview.schemabinding.version2.Property[0];\r
+    return (jalview.schemabinding.version2.Property[]) this._propertyList\r
+            .toArray(array);\r
+  }\r
+\r
+  /**\r
+   * Method getPropertyCount.\r
+   * \r
+   * @return the size of this collection\r
+   */\r
+  public int getPropertyCount()\r
+  {\r
+    return this._propertyList.size();\r
+  }\r
+\r
+  /**\r
      */\r
-    public void removeAllProperty(\r
-    ) {\r
-        this._propertyList.clear();\r
+  public void removeAllProperty()\r
+  {\r
+    this._propertyList.clear();\r
+  }\r
+\r
+  /**\r
+   * Method removeProperty.\r
+   * \r
+   * @param vProperty\r
+   * @return true if the object was removed from the collection.\r
+   */\r
+  public boolean removeProperty(\r
+          final jalview.schemabinding.version2.Property vProperty)\r
+  {\r
+    boolean removed = _propertyList.remove(vProperty);\r
+    return removed;\r
+  }\r
+\r
+  /**\r
+   * Method removePropertyAt.\r
+   * \r
+   * @param index\r
+   * @return the element removed from the collection\r
+   */\r
+  public jalview.schemabinding.version2.Property removePropertyAt(\r
+          final int index)\r
+  {\r
+    java.lang.Object obj = this._propertyList.remove(index);\r
+    return (jalview.schemabinding.version2.Property) obj;\r
+  }\r
+\r
+  /**\r
+   * \r
+   * \r
+   * @param index\r
+   * @param vProperty\r
+   * @throws java.lang.IndexOutOfBoundsException\r
+   *           if the index given is outside the bounds of the collection\r
+   */\r
+  public void setProperty(final int index,\r
+          final jalview.schemabinding.version2.Property vProperty)\r
+          throws java.lang.IndexOutOfBoundsException\r
+  {\r
+    // check bounds for index\r
+    if (index < 0 || index >= this._propertyList.size())\r
+    {\r
+      throw new IndexOutOfBoundsException("setProperty: Index value '"\r
+              + index + "' not in range [0.."\r
+              + (this._propertyList.size() - 1) + "]");\r
     }\r
 \r
-    /**\r
-     * Method removeProperty.\r
-     * \r
-     * @param vProperty\r
-     * @return true if the object was removed from the collection.\r
-     */\r
-    public boolean removeProperty(\r
-            final jalview.schemabinding.version2.Property vProperty) {\r
-        boolean removed = _propertyList.remove(vProperty);\r
-        return removed;\r
-    }\r
-\r
-    /**\r
-     * Method removePropertyAt.\r
-     * \r
-     * @param index\r
-     * @return the element removed from the collection\r
-     */\r
-    public jalview.schemabinding.version2.Property removePropertyAt(\r
-            final int index) {\r
-        java.lang.Object obj = this._propertyList.remove(index);\r
-        return (jalview.schemabinding.version2.Property) obj;\r
-    }\r
-\r
-    /**\r
-     * \r
-     * \r
-     * @param index\r
-     * @param vProperty\r
-     * @throws java.lang.IndexOutOfBoundsException if the index\r
-     * given is outside the bounds of the collection\r
-     */\r
-    public void setProperty(\r
-            final int index,\r
-            final jalview.schemabinding.version2.Property vProperty)\r
-    throws java.lang.IndexOutOfBoundsException {\r
-        // check bounds for index\r
-        if (index < 0 || index >= this._propertyList.size()) {\r
-            throw new IndexOutOfBoundsException("setProperty: Index value '" + index + "' not in range [0.." + (this._propertyList.size() - 1) + "]");\r
-        }\r
-        \r
-        this._propertyList.set(index, vProperty);\r
-    }\r
-\r
-    /**\r
-     * \r
-     * \r
-     * @param vPropertyArray\r
-     */\r
-    public void setProperty(\r
-            final jalview.schemabinding.version2.Property[] vPropertyArray) {\r
-        //-- copy array\r
-        _propertyList.clear();\r
-        \r
-        for (int i = 0; i < vPropertyArray.length; i++) {\r
-                this._propertyList.add(vPropertyArray[i]);\r
-        }\r
+    this._propertyList.set(index, vProperty);\r
+  }\r
+\r
+  /**\r
+   * \r
+   * \r
+   * @param vPropertyArray\r
+   */\r
+  public void setProperty(\r
+          final jalview.schemabinding.version2.Property[] vPropertyArray)\r
+  {\r
+    // -- copy array\r
+    _propertyList.clear();\r
+\r
+    for (int i = 0; i < vPropertyArray.length; i++)\r
+    {\r
+      this._propertyList.add(vPropertyArray[i]);\r
     }\r
+  }\r
 \r
 }\r