JAL-1645 source formatting and organise imports
[jalview.git] / src / jalview / schemabinding / version2 / Pdbentry.java
index b5acfbd..65de364 100644 (file)
@@ -7,8 +7,8 @@
 
 package jalview.schemabinding.version2;
 
-  //---------------------------------/
- //- Imported classes and packages -/
+//---------------------------------/
+//- Imported classes and packages -/
 //---------------------------------/
 
 import org.exolab.castor.xml.Marshaller;
@@ -19,334 +19,357 @@ import org.exolab.castor.xml.Unmarshaller;
  * 
  * @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;
+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)
+              + "]");
     }
 
-    /**
-     * Sets the value of field 'id'.
-     * 
-     * @param id the value of field 'id'.
-     */
-    public void setId(
-            final java.lang.String id) {
-        this._id = id;
+    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;
     }
-
-    /**
-     * 
-     * 
-     * @param index
-     * @param vPdbentryItem
-     * @throws java.lang.IndexOutOfBoundsException if the index
-     * given is outside the bounds of the collection
+    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 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);
+  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)
+              + "]");
     }
 
-    /**
-     * 
-     * 
-     * @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);
+    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);
+  }
 
 }