X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fschemabinding%2Fversion2%2FPdbids.java;h=04685b9fe3536bdb7728a248f74d114a2fac4a98;hb=09ee1649c4427f534331aa2017a890529f0932f5;hp=347ff351cbac44b17c44be03080a8ea8056f3815;hpb=45964a5011035526f997fb39bfc58dec53ffbcec;p=jalview.git diff --git a/src/jalview/schemabinding/version2/Pdbids.java b/src/jalview/schemabinding/version2/Pdbids.java index 347ff35..04685b9 100755 --- a/src/jalview/schemabinding/version2/Pdbids.java +++ b/src/jalview/schemabinding/version2/Pdbids.java @@ -1,6 +1,6 @@ /* * This class was automatically generated with - * Castor 0.9.6, using an XML + * Castor 1.1, using an XML * Schema. * $Id$ */ @@ -11,17 +11,8 @@ package jalview.schemabinding.version2; //- Imported classes and packages -/ //---------------------------------/ -import java.io.IOException; -import java.io.Reader; -import java.io.Serializable; -import java.io.Writer; -import java.util.Enumeration; -import java.util.Vector; -import org.exolab.castor.xml.MarshalException; import org.exolab.castor.xml.Marshaller; import org.exolab.castor.xml.Unmarshaller; -import org.exolab.castor.xml.ValidationException; -import org.xml.sax.ContentHandler; /** * Class Pdbids. @@ -38,7 +29,7 @@ implements java.io.Serializable //--------------------------/ /** - * Field _structureStateList + * Field _structureStateList. */ private java.util.Vector _structureStateList; @@ -49,8 +40,8 @@ implements java.io.Serializable public Pdbids() { super(); - _structureStateList = new Vector(); - } //-- jalview.schemabinding.version2.Pdbids() + this._structureStateList = new java.util.Vector(); + } //-----------/ @@ -58,219 +49,232 @@ implements java.io.Serializable //-----------/ /** - * Method addStructureState - * * * * @param vStructureState + * @throws java.lang.IndexOutOfBoundsException if the index + * given is outside the bounds of the collection */ - public void addStructureState(jalview.schemabinding.version2.StructureState vStructureState) - throws java.lang.IndexOutOfBoundsException - { - _structureStateList.addElement(vStructureState); - } //-- void addStructureState(jalview.schemabinding.version2.StructureState) + public void addStructureState( + final jalview.schemabinding.version2.StructureState vStructureState) + throws java.lang.IndexOutOfBoundsException { + this._structureStateList.addElement(vStructureState); + } /** - * Method addStructureState - * * * * @param index * @param vStructureState + * @throws java.lang.IndexOutOfBoundsException if the index + * given is outside the bounds of the collection */ - public void addStructureState(int index, jalview.schemabinding.version2.StructureState vStructureState) - throws java.lang.IndexOutOfBoundsException - { - _structureStateList.insertElementAt(vStructureState, index); - } //-- void addStructureState(int, jalview.schemabinding.version2.StructureState) + public void addStructureState( + final int index, + final jalview.schemabinding.version2.StructureState vStructureState) + throws java.lang.IndexOutOfBoundsException { + this._structureStateList.add(index, vStructureState); + } /** - * Method enumerateStructureState - * - * + * Method enumerateStructureState. * - * @return Enumeration + * @return an Enumeration over all + * jalview.schemabinding.version2.StructureState elements */ - public java.util.Enumeration enumerateStructureState() - { - return _structureStateList.elements(); - } //-- java.util.Enumeration enumerateStructureState() + public java.util.Enumeration enumerateStructureState( + ) { + return this._structureStateList.elements(); + } /** - * Method getStructureState - * - * + * Method getStructureState. * * @param index - * @return StructureState + * @throws java.lang.IndexOutOfBoundsException if the index + * given is outside the bounds of the collection + * @return the value of the + * jalview.schemabinding.version2.StructureState at the given + * index */ - public jalview.schemabinding.version2.StructureState getStructureState(int index) - throws java.lang.IndexOutOfBoundsException - { - //-- check bounds for index - if ((index < 0) || (index > _structureStateList.size())) { - throw new IndexOutOfBoundsException(); + public jalview.schemabinding.version2.StructureState getStructureState( + final int index) + throws java.lang.IndexOutOfBoundsException { + // check bounds for index + if (index < 0 || index >= this._structureStateList.size()) { + throw new IndexOutOfBoundsException("getStructureState: Index value '" + index + "' not in range [0.." + (this._structureStateList.size() - 1) + "]"); } - return (jalview.schemabinding.version2.StructureState) _structureStateList.elementAt(index); - } //-- jalview.schemabinding.version2.StructureState getStructureState(int) + return (jalview.schemabinding.version2.StructureState) _structureStateList.get(index); + } /** - * Method getStructureState - * - * - * - * @return StructureState + * Method getStructureState.Returns the contents of the + * collection in an Array.

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 know that the Array returned is of + * exactly the correct length. + * + * @return this collection as an Array */ - public jalview.schemabinding.version2.StructureState[] getStructureState() - { - int size = _structureStateList.size(); - jalview.schemabinding.version2.StructureState[] mArray = new jalview.schemabinding.version2.StructureState[size]; - for (int index = 0; index < size; index++) { - mArray[index] = (jalview.schemabinding.version2.StructureState) _structureStateList.elementAt(index); - } - return mArray; - } //-- jalview.schemabinding.version2.StructureState[] getStructureState() + public jalview.schemabinding.version2.StructureState[] getStructureState( + ) { + jalview.schemabinding.version2.StructureState[] array = new jalview.schemabinding.version2.StructureState[0]; + return (jalview.schemabinding.version2.StructureState[]) this._structureStateList.toArray(array); + } /** - * Method getStructureStateCount - * - * + * Method getStructureStateCount. * - * @return int + * @return the size of this collection */ - public int getStructureStateCount() - { - return _structureStateList.size(); - } //-- int getStructureStateCount() + public int getStructureStateCount( + ) { + return this._structureStateList.size(); + } /** - * Method isValid + * Method isValid. * - * - * - * @return boolean + * @return true if this object is valid according to the schema */ - public boolean isValid() - { + public boolean isValid( + ) { try { validate(); - } - catch (org.exolab.castor.xml.ValidationException vex) { + } catch (org.exolab.castor.xml.ValidationException vex) { return false; } return true; - } //-- boolean isValid() + } /** - * Method marshal - * * * * @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(java.io.Writer out) - throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException - { - + public void marshal( + final java.io.Writer out) + throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException { Marshaller.marshal(this, out); - } //-- void marshal(java.io.Writer) + } /** - * Method marshal - * * * * @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(org.xml.sax.ContentHandler handler) - throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException - { - + 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); - } //-- void marshal(org.xml.sax.ContentHandler) + } /** - * Method removeAllStructureState - * */ - public void removeAllStructureState() - { - _structureStateList.removeAllElements(); - } //-- void removeAllStructureState() + public void removeAllStructureState( + ) { + this._structureStateList.clear(); + } /** - * Method removeStructureState - * + * Method removeStructureState. * + * @param vStructureState + * @return true if the object was removed from the collection. + */ + public boolean removeStructureState( + final jalview.schemabinding.version2.StructureState vStructureState) { + boolean removed = _structureStateList.remove(vStructureState); + return removed; + } + + /** + * Method removeStructureStateAt. * * @param index - * @return StructureState + * @return the element removed from the collection */ - public jalview.schemabinding.version2.StructureState removeStructureState(int index) - { - java.lang.Object obj = _structureStateList.elementAt(index); - _structureStateList.removeElementAt(index); + public jalview.schemabinding.version2.StructureState removeStructureStateAt( + final int index) { + java.lang.Object obj = this._structureStateList.remove(index); return (jalview.schemabinding.version2.StructureState) obj; - } //-- jalview.schemabinding.version2.StructureState removeStructureState(int) + } /** - * Method setStructureState - * * * * @param index * @param vStructureState + * @throws java.lang.IndexOutOfBoundsException if the index + * given is outside the bounds of the collection */ - public void setStructureState(int index, jalview.schemabinding.version2.StructureState vStructureState) - throws java.lang.IndexOutOfBoundsException - { - //-- check bounds for index - if ((index < 0) || (index > _structureStateList.size())) { - throw new IndexOutOfBoundsException(); + public void setStructureState( + final int index, + final jalview.schemabinding.version2.StructureState vStructureState) + throws java.lang.IndexOutOfBoundsException { + // check bounds for index + if (index < 0 || index >= this._structureStateList.size()) { + throw new IndexOutOfBoundsException("setStructureState: Index value '" + index + "' not in range [0.." + (this._structureStateList.size() - 1) + "]"); } - _structureStateList.setElementAt(vStructureState, index); - } //-- void setStructureState(int, jalview.schemabinding.version2.StructureState) + + this._structureStateList.set(index, vStructureState); + } /** - * Method setStructureState - * * * - * @param structureStateArray + * @param vStructureStateArray */ - public void setStructureState(jalview.schemabinding.version2.StructureState[] structureStateArray) - { + public void setStructureState( + final jalview.schemabinding.version2.StructureState[] vStructureStateArray) { //-- copy array - _structureStateList.removeAllElements(); - for (int i = 0; i < structureStateArray.length; i++) { - _structureStateList.addElement(structureStateArray[i]); + _structureStateList.clear(); + + for (int i = 0; i < vStructureStateArray.length; i++) { + this._structureStateList.add(vStructureStateArray[i]); } - } //-- void setStructureState(jalview.schemabinding.version2.StructureState) + } /** - * Method unmarshal - * - * + * Method unmarshal. * * @param reader - * @return Object + * @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 java.lang.Object unmarshal(java.io.Reader reader) - throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException - { - return (jalview.schemabinding.version2.Pdbids) Unmarshaller.unmarshal(jalview.schemabinding.version2.Pdbids.class, reader); - } //-- java.lang.Object unmarshal(java.io.Reader) + 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.Pdbids.class, reader); + } /** - * Method validate * + * + * @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 - { + public void validate( + ) + throws org.exolab.castor.xml.ValidationException { org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator(); validator.validate(this); - } //-- void validate() + } }