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:

Serializable

public class XmlRelatedIdentifiers
extends Object
implements Serializable

Class RelatedIdentifiers.

Author:

arendd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmlRelatedIdentifiers()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRelatedIdentifier(int index, XmlRelatedIdentifier relatedIdentifier)
void	addRelatedIdentifier(XmlRelatedIdentifier relatedIdentifier)
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 IndexOutOfBoundsException

Parameters:

relatedIdentifier -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addRelatedIdentifier

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

Parameters:

index -

relatedIdentifier -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateRelatedIdentifier

public Iterator<? extends XmlRelatedIdentifier> enumerateRelatedIdentifier()

Method enumerateRelatedIdentifier.

Returns:

an Enumeration over all DataCite.RelatedIdentifier elements

getRelatedIdentifier

public XmlRelatedIdentifier getRelatedIdentifier(int index)
                                          throws IndexOutOfBoundsException

Method getRelatedIdentifier.

Parameters:

index -

Returns:

the value of the RelatedIdentifier at the given index

Throws:

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 -

Returns:

true if the object was removed from the collection.

removeRelatedIdentifierAt

public XmlRelatedIdentifier removeRelatedIdentifierAt(int index)

Method removeRelatedIdentifierAt.

Parameters:

index -

Returns:

the element removed from the collection

setRelatedIdentifier

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

Parameters:

index -

vRelatedIdentifier -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setRelatedIdentifier

public void setRelatedIdentifier(XmlRelatedIdentifier[] vRelatedIdentifierArray)

Parameters:

vRelatedIdentifierArray -