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

Class XmlDates

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

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

XML mapping class for the 'dates' element.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmlDates() Default constructor
XmlDates(DateEvents elementValue)

Method Summary

Modifier and Type	Method and Description
void	addDate(int index, XmlDate date) Add a XmlDate to the List of XmlDate at a specified position.
void	addDate(XmlDate date) Add a XmlDate to the List of XmlDate.
java.util.Iterator<? extends XmlDate>	enumerateDate() Return an Iterator of all XmlDate.
XmlDate[]	getDate() Returns the contents of the collection in an Array.
XmlDate	getDate(int index) Return the XmlDate at the specified position in the List.
int	getDateCount() Return the number of the XmlDate.
void	removeAllDate() Remove all XmlDate in the List.
boolean	removeDate(XmlDate date) Remove a specified XmlDate.
XmlDate	removeDateAt(int index) Remove a XmlDate at the specified position.
void	setDate(int index, XmlDate date) Set the XmlDate at the specified position of the List.
void	setDate(XmlDate[] dateArray) Set a all XmlDate to the List.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDates

public XmlDates()

Default constructor

XmlDates

public XmlDates(DateEvents elementValue)

Method Detail

addDate

public void addDate(XmlDate date)
             throws java.lang.IndexOutOfBoundsException

Add a XmlDate to the List of XmlDate.

Parameters:

date - the XmlDate to add.

Throws:

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

addDate

public void addDate(int index,
                    XmlDate date)
             throws java.lang.IndexOutOfBoundsException

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

Parameters:

index - the position to insert the XmlDate.

date - the XmlDate to add.

Throws:

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

enumerateDate

public java.util.Iterator<? extends XmlDate> enumerateDate()

Return an Iterator of all XmlDate.

Returns:

an Iterator over all XmlDate elements.

getDate

public XmlDate getDate(int index)
                throws java.lang.IndexOutOfBoundsException

Return the XmlDate at the specified position in the List.

Parameters:

index - the position of the searched XmlDate.

Returns:

the value of the XmlDate at the given index

Throws:

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

getDate

public XmlDate[] getDate()

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

getDateCount

public int getDateCount()

Return the number of the XmlDate.

Returns:

the size of this collection

removeAllDate

public void removeAllDate()

Remove all XmlDate in the List.

removeDate

public boolean removeDate(XmlDate date)

Remove a specified XmlDate.

Parameters:

date - the XmlDate to remove.

Returns:

true if the object was removed from the collection.

removeDateAt

public XmlDate removeDateAt(int index)

Remove a XmlDate at the specified position.

Parameters:

index - the position of the XmlDate to remove.

Returns:

the element removed from the collection

setDate

public void setDate(int index,
                    XmlDate date)
             throws java.lang.IndexOutOfBoundsException

Set the XmlDate at the specified position of the List.

Parameters:

index - the position to set the XmlDate.

date - the XmlDate to set.

Throws:

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

setDate

public void setDate(XmlDate[] dateArray)

Set a all XmlDate to the List.

Parameters:

dateArray - the array of dates to set