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

Class XmlCreators

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class XmlCreators
extends Object
implements Serializable

XML Mapping class for the 'creators' element.

Author:

arendd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmlCreators() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addCreator(int index, XmlCreator creator) Add a XmlCreator to the List of XmlCreators at a specified position.
void	addCreator(XmlCreator creator) Add a XmlCreator to the List of XmlCreators.
Iterator<? extends XmlCreator>	enumerateCreator() Return an Iterator of all XmlCreator.
XmlCreator[]	getCreator() Returns the contents of the List in an Array.
XmlCreator	getCreator(int index) Return the XmlCreator at the specified position in the List.
int	getCreatorCount() Return the number of the XmlCreator.
void	removeAllCreator() Remove all XmlCreator in the List.
boolean	removeCreator(XmlCreator creator) Remove a specified XmlCreator.
XmlCreator	removeCreatorAt(int index) Remove a XmlCreator at the specified position.
void	setCreator(int index, XmlCreator creator) Set the XmlCreator at the specified position of the List.
void	setCreator(XmlCreator[] creatorArray) Set a all XmlCreator to the List.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlCreators

public XmlCreators()

Default constructor

Method Detail

addCreator

public void addCreator(XmlCreator creator)
                throws IndexOutOfBoundsException

Add a XmlCreator to the List of XmlCreators.

Parameters:

creator - the XmlCreator to add.

Throws:

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

addCreator

public void addCreator(int index,
              XmlCreator creator)
                throws IndexOutOfBoundsException

Add a XmlCreator to the List of XmlCreators at a specified position.

Parameters:

index - the position to insert the XmlCreator.

creator - the XmlCreator to add.

Throws:

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

enumerateCreator

public Iterator<? extends XmlCreator> enumerateCreator()

Return an Iterator of all XmlCreator.

Returns:

an Iterator over all XmlCreator elements.

getCreator

public XmlCreator getCreator(int index)
                      throws IndexOutOfBoundsException

Return the XmlCreator at the specified position in the List.

Parameters:

index - the position of the searched XmlCreator.

Returns:

the value of the XmlCreator at the given index

Throws:

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

getCreator

public XmlCreator[] getCreator()

Returns the contents of the List 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:

an Array of XmlCreator.

getCreatorCount

public int getCreatorCount()

Return the number of the XmlCreator.

Returns:

the size of this collection

removeAllCreator

public void removeAllCreator()

Remove all XmlCreator in the List.

removeCreator

public boolean removeCreator(XmlCreator creator)

Remove a specified XmlCreator.

Parameters:

creator - the XmlCreator to remove.

Returns:

true if the object was removed from the collection.

removeCreatorAt

public XmlCreator removeCreatorAt(int index)

Remove a XmlCreator at the specified position.

Parameters:

index - the position of the XmlCreator to remove.

Returns:

the element removed from the collection

setCreator

public void setCreator(int index,
              XmlCreator creator)
                throws IndexOutOfBoundsException

Set the XmlCreator at the specified position of the List.

Parameters:

index - the position to set the XmlCreator.

creator - the XmlCreator to set.

Throws:

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

setCreator

public void setCreator(XmlCreator[] creatorArray)

Set a all XmlCreator to the List.

Parameters:

creatorArray -