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 Entry + * @return this collection as an Array */ - public uk.ac.vamsas.objects.core.Entry[] getEntry() - { - int size = _entryList.size(); - uk.ac.vamsas.objects.core.Entry[] mArray = new uk.ac.vamsas.objects.core.Entry[size]; - for (int index = 0; index < size; index++) { - mArray[index] = (uk.ac.vamsas.objects.core.Entry) _entryList.elementAt(index); - } - return mArray; - } //-- uk.ac.vamsas.objects.core.Entry[] getEntry() + public uk.ac.vamsas.objects.core.Entry[] getEntry( + ) { + uk.ac.vamsas.objects.core.Entry[] array = new uk.ac.vamsas.objects.core.Entry[0]; + return (uk.ac.vamsas.objects.core.Entry[]) this._entryList.toArray(array); + } /** - * Method getEntryCount - * - * + * Method getEntryAsReference.Returns a reference to + * '_entryList'. No type checking is performed on any + * modifications to the Vector. * - * @return int + * @return a reference to the Vector backing this class */ - public int getEntryCount() - { - return _entryList.size(); - } //-- int getEntryCount() + public java.util.Vector getEntryAsReference( + ) { + return this._entryList; + } /** - * Method isValid + * Method getEntryCount. * + * @return the size of this collection + */ + public int getEntryCount( + ) { + return this._entryList.size(); + } + + /** + * Overrides the java.lang.Object.hashCode method. + *
+ * The following steps came from Effective Java Programming + * Language Guide by Joshua Bloch, Chapter 3 * + * @return a hash code value for the object. + */ + public int hashCode( + ) { + int result = super.hashCode(); + + long tmp; + if (_entryList != null) { + result = 37 * result + _entryList.hashCode(); + } + + return result; + } + + /** + * 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 removeAllEntry - * */ - public void removeAllEntry() - { - _entryList.removeAllElements(); - } //-- void removeAllEntry() + public void removeAllEntry( + ) { + this._entryList.clear(); + } /** - * Method removeEntry - * + * Method removeEntry. * + * @param vEntry + * @return true if the object was removed from the collection. + */ + public boolean removeEntry( + final uk.ac.vamsas.objects.core.Entry vEntry) { + boolean removed = _entryList.remove(vEntry); + return removed; + } + + /** + * Method removeEntryAt. * * @param index - * @return Entry + * @return the element removed from the collection */ - public uk.ac.vamsas.objects.core.Entry removeEntry(int index) - { - java.lang.Object obj = _entryList.elementAt(index); - _entryList.removeElementAt(index); + public uk.ac.vamsas.objects.core.Entry removeEntryAt( + final int index) { + java.lang.Object obj = this._entryList.remove(index); return (uk.ac.vamsas.objects.core.Entry) obj; - } //-- uk.ac.vamsas.objects.core.Entry removeEntry(int) + } /** - * Method setEntry - * * * * @param index * @param vEntry + * @throws java.lang.IndexOutOfBoundsException if the index + * given is outside the bounds of the collection */ - public void setEntry(int index, uk.ac.vamsas.objects.core.Entry vEntry) - throws java.lang.IndexOutOfBoundsException - { - //-- check bounds for index - if ((index < 0) || (index > _entryList.size())) { - throw new IndexOutOfBoundsException("setEntry: Index value '"+index+"' not in range [0.."+_entryList.size()+ "]"); + public void setEntry( + final int index, + final uk.ac.vamsas.objects.core.Entry vEntry) + throws java.lang.IndexOutOfBoundsException { + // check bounds for index + if (index < 0 || index >= this._entryList.size()) { + throw new IndexOutOfBoundsException("setEntry: Index value '" + index + "' not in range [0.." + (this._entryList.size() - 1) + "]"); } - _entryList.setElementAt(vEntry, index); - } //-- void setEntry(int, uk.ac.vamsas.objects.core.Entry) + + this._entryList.set(index, vEntry); + } /** - * Method setEntry * * - * - * @param entryArray + * @param vEntryArray */ - public void setEntry(uk.ac.vamsas.objects.core.Entry[] entryArray) - { + public void setEntry( + final uk.ac.vamsas.objects.core.Entry[] vEntryArray) { //-- copy array - _entryList.removeAllElements(); - for (int i = 0; i < entryArray.length; i++) { - _entryList.addElement(entryArray[i]); + _entryList.clear(); + + for (int i = 0; i < vEntryArray.length; i++) { + this._entryList.add(vEntryArray[i]); } - } //-- void setEntry(uk.ac.vamsas.objects.core.Entry) + } /** - * Method unmarshal + * Sets the value of '_entryList' by copying the given Vector. + * All elements will be checked for type safety. * + * @param vEntryList the Vector to copy. + */ + public void setEntry( + final java.util.Vector vEntryList) { + // copy vector + this._entryList.clear(); + + this._entryList.addAll(vEntryList); + } + + /** + * Sets the value of '_entryList' by setting it to the given + * Vector. No type checking is performed. + * @deprecated * + * @param entryVector the Vector to set. + */ + public void setEntryAsReference( + final java.util.Vector entryVector) { + this._entryList = entryVector; + } + + /** + * Method unmarshal. * * @param reader - * @return Provenance + * @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 uk.ac.vamsas.objects.core.Provenance */ - public static uk.ac.vamsas.objects.core.Provenance unmarshal(java.io.Reader reader) - throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException - { + public static uk.ac.vamsas.objects.core.Provenance unmarshal( + final java.io.Reader reader) + throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException { return (uk.ac.vamsas.objects.core.Provenance) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Provenance.class, reader); - } //-- uk.ac.vamsas.objects.core.Provenance unmarshal(java.io.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() + } }