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

Class XmlAlternateIdentifiers

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class XmlAlternateIdentifiers
extends Object
implements Serializable

XML mapping class for the 'alternativeIdentifiers' element.

Author:

arendd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmlAlternateIdentifiers() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlternateIdentifier(int index, XmlAlternateIdentifier alternateIdentifier) Add a XmlAlternateIdentifier to the List of XmlAlternateIdentifier at a specified position.
void	addAlternateIdentifier(XmlAlternateIdentifier alternateIdentifier) Add a XmlAlternateIdentifier to the List of XmlAlternateIdentifier.
Iterator<? extends XmlAlternateIdentifier>	enumerateAlternateIdentifier() Return an Iterator of all XmlAlternateIdentifier.
XmlAlternateIdentifier[]	getAlternateIdentifier() Returns the contents of the collection in an Array.
XmlAlternateIdentifier	getAlternateIdentifier(int index) Return the XmlAlternateIdentifier at the specified position in the List.
int	getAlternateIdentifierCount() Return the number of the XmlAlternateIdentifier.
void	removeAllAlternateIdentifier() Remove all XmlAlternateIdentifier in the List.
boolean	removeAlternateIdentifier(XmlAlternateIdentifier alternateIdentifier) Remove a specified XmlAlternateIdentifier.
XmlAlternateIdentifier	removeAlternateIdentifierAt(int index) Remove a XmlAlternateIdentifier at the specified position.
void	setAlternateIdentifier(int index, XmlAlternateIdentifier alternateIdentifier) Set the XmlAlternateIdentifier at the specified position of the List.
void	setAlternateIdentifier(XmlAlternateIdentifier[] alternateIdentifierArray) Set a all XmlAlternateIdentifier to the List.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlAlternateIdentifiers

public XmlAlternateIdentifiers()

Default constructor.

Method Detail

addAlternateIdentifier

public void addAlternateIdentifier(XmlAlternateIdentifier alternateIdentifier)
                            throws IndexOutOfBoundsException

Add a XmlAlternateIdentifier to the List of XmlAlternateIdentifier.

Parameters:

alternateIdentifier - the XmlAlternateIdentifier to add.

Throws:

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

addAlternateIdentifier

public void addAlternateIdentifier(int index,
                          XmlAlternateIdentifier alternateIdentifier)
                            throws IndexOutOfBoundsException

Add a XmlAlternateIdentifier to the List of XmlAlternateIdentifier at a specified position.

Parameters:

index - the position to insert the XmlAlternateIdentifier.

alternateIdentifier - the XmlAlternateIdentifier to add.

Throws:

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

enumerateAlternateIdentifier

public Iterator<? extends XmlAlternateIdentifier> enumerateAlternateIdentifier()

Return an Iterator of all XmlAlternateIdentifier.

Returns:

an Iterator over all XmlAlternateIdentifier elements.

getAlternateIdentifier

public XmlAlternateIdentifier getAlternateIdentifier(int index)
                                              throws IndexOutOfBoundsException

Return the XmlAlternateIdentifier at the specified position in the List.

Parameters:

index - the position of the searched XmlAlternateIdentifier.

Returns:

the value of the XmlAlternateIdentifier at the given index

Throws:

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

getAlternateIdentifier

public XmlAlternateIdentifier[] getAlternateIdentifier()

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

getAlternateIdentifierCount

public int getAlternateIdentifierCount()

Return the number of the XmlAlternateIdentifier.

Returns:

the size of this collection

removeAllAlternateIdentifier

public void removeAllAlternateIdentifier()

Remove all XmlAlternateIdentifier in the List.

removeAlternateIdentifier

public boolean removeAlternateIdentifier(XmlAlternateIdentifier alternateIdentifier)

Remove a specified XmlAlternateIdentifier.

Parameters:

alternateIdentifier - the XmlAlternateIdentifier to remove.

Returns:

true if the object was removed from the collection.

removeAlternateIdentifierAt

public XmlAlternateIdentifier removeAlternateIdentifierAt(int index)

Remove a XmlAlternateIdentifier at the specified position.

Parameters:

index - the position of the XmlAlternateIdentifier to remove.

Returns:

the element removed from the collection

setAlternateIdentifier

public void setAlternateIdentifier(int index,
                          XmlAlternateIdentifier alternateIdentifier)
                            throws IndexOutOfBoundsException

Set the XmlAlternateIdentifier at the specified position of the List.

Parameters:

index - the position to set the XmlAlternateIdentifier.

alternateIdentifier - the XmlAlternateIdentifier to set.

Throws:

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

setAlternateIdentifier

public void setAlternateIdentifier(XmlAlternateIdentifier[] alternateIdentifierArray)

Set a all XmlAlternateIdentifier to the List.

Parameters:

alternateIdentifierArray -