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

Class XmlDescriptions

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

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

XML mapping class for the 'descriptions' element.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
XmlDescriptions()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addDescription(int index, XmlDescription description)	Add a XmlDescription to the List of XmlDescription at a specified position.
void	addDescription(XmlDescription description)	Add a XmlDescription to the List of XmlDescription.
java.util.Iterator<? extends XmlDescription>	enumerateDescription()	Return an Iterator of all XmlDescription.
XmlDescription[]	getDescription()	Returns the contents of the collection in an Array.
XmlDescription	getDescription(int index)	Return the XmlDescription at the specified position in the List.
int	getDescriptionCount()	Return the number of the XmlDescription.
void	removeAllDescription()	Remove all XmlDescription in the List.
boolean	removeDescription(XmlDescription description)	Remove a specified XmlDescription.
XmlDescription	removeDescriptionAt(int index)	Remove a XmlDescription at the specified position.
void	setDescription(int index, XmlDescription description)	Set the XmlDescription at the specified position of the List.
void	setDescription(XmlDescription[] descriptionArray)	Set a all XmlDescription to the List.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDescriptions

public XmlDescriptions()

Default constructor.

Method Detail

addDescription

public void addDescription(XmlDescription description)
                    throws java.lang.IndexOutOfBoundsException

Add a XmlDescription to the List of XmlDescription.

Parameters:

description - the XmlDescription to add.

Throws:

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

addDescription

public void addDescription(int index,
                           XmlDescription description)
                    throws java.lang.IndexOutOfBoundsException

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

Parameters:

index - the position to insert the XmlDescription.

description - the XmlDescription to add.

Throws:

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

enumerateDescription

public java.util.Iterator<? extends XmlDescription> enumerateDescription()

Return an Iterator of all XmlDescription.

Returns:

an Iterator over all XmlDescription elements.

getDescription

public XmlDescription getDescription(int index)
                              throws java.lang.IndexOutOfBoundsException

Return the XmlDescription at the specified position in the List.

Parameters:

index - the position of the searched XmlDescription.

Returns:

the value of the XmlDescription at the given index

Throws:

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

getDescription

public XmlDescription[] getDescription()

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

getDescriptionCount

public int getDescriptionCount()

Return the number of the XmlDescription.

Returns:

the size of this collection

removeAllDescription

public void removeAllDescription()

Remove all XmlDescription in the List.

removeDescription

public boolean removeDescription(XmlDescription description)

Remove a specified XmlDescription.

Parameters:

description - the XmlDescription to remove.

Returns:

true if the object was removed from the collection.

removeDescriptionAt

public XmlDescription removeDescriptionAt(int index)

Remove a XmlDescription at the specified position.

Parameters:

index - the position of the XmlDescription to remove.

Returns:

the element removed from the collection

setDescription

public void setDescription(int index,
                           XmlDescription description)
                    throws java.lang.IndexOutOfBoundsException

Set the XmlDescription at the specified position of the List.

Parameters:

index - the position to set the XmlDescription.

description - the XmlDescription to set.

Throws:

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

setDescription

public void setDescription(XmlDescription[] descriptionArray)

Set a all XmlDescription to the List.

Parameters:

descriptionArray - the array of descriptions to set