Package de.ipk_gatersleben.bit.bi.edal.primary_data.reference.datacite.xml

Class XmlRelatedIdentifiers

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.primary_data.reference.datacite.xml.XmlRelatedIdentifiers

All Implemented Interfaces:

java.io.Serializable

public class XmlRelatedIdentifiers
extends java.lang.Object
implements java.io.Serializable

Class RelatedIdentifiers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
XmlRelatedIdentifiers()

Method Summary

Modifier and Type	Method	Description
void	addRelatedIdentifier(int index, XmlRelatedIdentifier relatedIdentifier)
void	addRelatedIdentifier(XmlRelatedIdentifier relatedIdentifier)
java.util.Iterator<? extends XmlRelatedIdentifier>	enumerateRelatedIdentifier()	Method enumerateRelatedIdentifier.
XmlRelatedIdentifier[]	getRelatedIdentifier()	Method getRelatedIdentifier.Returns the contents of the collection in an Array.
XmlRelatedIdentifier	getRelatedIdentifier(int index)	Method getRelatedIdentifier.
int	getRelatedIdentifierCount()	Method getRelatedIdentifierCount.
void	removeAllRelatedIdentifier()	Method removeAllRelatedIdentifier.
boolean	removeRelatedIdentifier(XmlRelatedIdentifier vRelatedIdentifier)	Method removeRelatedIdentifier.
XmlRelatedIdentifier	removeRelatedIdentifierAt(int index)	Method removeRelatedIdentifierAt.
void	setRelatedIdentifier(int index, XmlRelatedIdentifier vRelatedIdentifier)
void	setRelatedIdentifier(XmlRelatedIdentifier[] vRelatedIdentifierArray)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlRelatedIdentifiers

public XmlRelatedIdentifiers()

Method Detail

addRelatedIdentifier

public void addRelatedIdentifier(XmlRelatedIdentifier relatedIdentifier)
                          throws java.lang.IndexOutOfBoundsException

Parameters:

relatedIdentifier - the related identifier to add

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addRelatedIdentifier

public void addRelatedIdentifier(int index,
                                 XmlRelatedIdentifier relatedIdentifier)
                          throws java.lang.IndexOutOfBoundsException

Parameters:

index - the index to add the related identifier

relatedIdentifier - the related identifier to add

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateRelatedIdentifier

public java.util.Iterator<? extends XmlRelatedIdentifier> enumerateRelatedIdentifier()

Method enumerateRelatedIdentifier.

Returns:

an Enumeration over all DataCite.RelatedIdentifier elements

getRelatedIdentifier

public XmlRelatedIdentifier getRelatedIdentifier(int index)
                                          throws java.lang.IndexOutOfBoundsException

Method getRelatedIdentifier.

Parameters:

index - the index to get the related identifier

Returns:

the value of the RelatedIdentifier at the given index

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getRelatedIdentifier

public XmlRelatedIdentifier[] getRelatedIdentifier()

Method getRelatedIdentifier.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.

Returns:

this collection as an Array

getRelatedIdentifierCount

public int getRelatedIdentifierCount()

Method getRelatedIdentifierCount.

Returns:

the size of this collection

removeAllRelatedIdentifier

public void removeAllRelatedIdentifier()

Method removeAllRelatedIdentifier.

removeRelatedIdentifier

public boolean removeRelatedIdentifier(XmlRelatedIdentifier vRelatedIdentifier)

Method removeRelatedIdentifier.

Parameters:

vRelatedIdentifier - the related identifier to remove

Returns:

true if the object was removed from the collection.

removeRelatedIdentifierAt

public XmlRelatedIdentifier removeRelatedIdentifierAt(int index)

Method removeRelatedIdentifierAt.

Parameters:

index - the index to remove the related identifier

Returns:

the element removed from the collection

setRelatedIdentifier

public void setRelatedIdentifier(int index,
                                 XmlRelatedIdentifier vRelatedIdentifier)
                          throws java.lang.IndexOutOfBoundsException

Parameters:

index - the index to set the related identifier

vRelatedIdentifier - the related identifier to set

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setRelatedIdentifier

public void setRelatedIdentifier(XmlRelatedIdentifier[] vRelatedIdentifierArray)

Parameters:

vRelatedIdentifierArray - the array of related identifiers to set