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

Class XmlContributors

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class XmlContributors
extends Object
implements Serializable

XML mapping class for the 'contributors' element.

Author:

arendd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmlContributors() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addContributor(int index, XmlContributor contributor) Add a XmlContributor to the List of XmlContributor at a specified position.
void	addContributor(XmlContributor contributor) Add a XmlContributor to the List of XmlContributor.
Iterator<? extends XmlContributor>	enumerateContributor() Return an Iterator of all XmlContributor.
XmlContributor[]	getContributor() Returns the contents of the collection in an Array.
XmlContributor	getContributor(int index) Return the XmlContributor at the specified position in the List.
int	getContributorCount() Return the number of the XmlContributor.
void	removeAllContributor() Remove all XmlContributor in the List.
boolean	removeContributor(XmlContributor contributor) Remove a specified XmlContributor.
XmlContributor	removeContributorAt(int index) Remove a XmlContributor at the specified position.
void	setContributor(int index, XmlContributor contributor) Set the XmlContributor at the specified position of the List.
void	setContributor(XmlContributor[] contributorArray) Set a all XmlContributor to the List.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlContributors

public XmlContributors()

Default constructor.

Method Detail

addContributor

public void addContributor(XmlContributor contributor)
                    throws IndexOutOfBoundsException

Add a XmlContributor to the List of XmlContributor.

Parameters:

contributor - the XmlContributor to add.

Throws:

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

addContributor

public void addContributor(int index,
                  XmlContributor contributor)
                    throws IndexOutOfBoundsException

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

Parameters:

index - the position to insert the XmlContributor.

contributor - the XmlContributor to add.

Throws:

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

enumerateContributor

public Iterator<? extends XmlContributor> enumerateContributor()

Return an Iterator of all XmlContributor.

Returns:

an Iterator over all XmlContributor elements.

getContributor

public XmlContributor getContributor(int index)
                              throws IndexOutOfBoundsException

Return the XmlContributor at the specified position in the List.

Parameters:

index - the position of the searched XmlContributor.

Returns:

the value of the XmlContributor at the given index

Throws:

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

getContributor

public XmlContributor[] getContributor()

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

getContributorCount

public int getContributorCount()

Return the number of the XmlContributor.

Returns:

the size of this collection

removeAllContributor

public void removeAllContributor()

Remove all XmlContributor in the List.

removeContributor

public boolean removeContributor(XmlContributor contributor)

Remove a specified XmlContributor.

Parameters:

contributor - the XmlContributor to remove.

Returns:

true if the object was removed from the collection.

removeContributorAt

public XmlContributor removeContributorAt(int index)

Remove a XmlContributor at the specified position.

Parameters:

index - the position of the XmlContributor to remove.

Returns:

the element removed from the collection

setContributor

public void setContributor(int index,
                  XmlContributor contributor)
                    throws IndexOutOfBoundsException

Set the XmlContributor at the specified position of the List.

Parameters:

index - the position to set the XmlContributor.

contributor - the XmlContributor to set.

Throws:

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

setContributor

public void setContributor(XmlContributor[] contributorArray)

Set a all XmlContributor to the List.

Parameters:

contributorArray - the array of XmlContributor to set.