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

Class XmlGeoLocations

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
XmlGeoLocations()

Method Summary

Modifier and Type	Method	Description
void	addGeoLocation(int index, XmlGeoLocation geoLocation)	Add a XmlGeoLocation to the List of XmlGeoLocation at a specified position.
void	addGeoLocation(XmlGeoLocation geoLocation)	Add a XmlGeoLocation to the List of XmlGeoLocation.
java.util.Iterator<? extends XmlGeoLocation>	enumerateGeoLocation()	Return an Iterator of all XmlGeoLocation.
XmlGeoLocation[]	getgeoLocation()	Returns the contents of the collection in an Array.
XmlGeoLocation	getGeoLocation(int index)	Return the XmlGeoLocation at the specified position in the List.
int	getGeoLocationCount()	Return the number of the XmlGeoLocation.
void	removeAllGeoLocation()	Remove all XmlGeoLocation in the List.
boolean	removeGeoLocation(XmlGeoLocation geoLocation)	Remove a specified XmlGeoLocation.
XmlGeoLocation	removeGeoLocationAt(int index)	Remove a XmlGeoLocation at the specified position.
void	setGeoLocation(int index, XmlGeoLocation geoLocation)	Set the XmlGeoLocation at the specified position of the List.
void	setGeoLocation(XmlGeoLocation[] geoLocationArray)	Set a all XmlGeoLocation to the List.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlGeoLocations

public XmlGeoLocations()

Method Detail

addGeoLocation

public void addGeoLocation(XmlGeoLocation geoLocation)
                    throws java.lang.IndexOutOfBoundsException

Add a XmlGeoLocation to the List of XmlGeoLocation.

Parameters:

geoLocation - the XmlGeoLocation to add.

Throws:

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

addGeoLocation

public void addGeoLocation(int index,
                           XmlGeoLocation geoLocation)
                    throws java.lang.IndexOutOfBoundsException

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

Parameters:

index - the position to insert the XmlGeoLocation.

geoLocation - the XmlGeoLocation to add.

Throws:

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

enumerateGeoLocation

public java.util.Iterator<? extends XmlGeoLocation> enumerateGeoLocation()

Return an Iterator of all XmlGeoLocation.

Returns:

an Iterator over all XmlGeoLocation elements.

getGeoLocation

public XmlGeoLocation getGeoLocation(int index)
                              throws java.lang.IndexOutOfBoundsException

Return the XmlGeoLocation at the specified position in the List.

Parameters:

index - the position of the searched XmlGeoLocation.

Returns:

the value of the XmlGeoLocation at the given index

Throws:

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

getgeoLocation

public XmlGeoLocation[] getgeoLocation()

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

getGeoLocationCount

public int getGeoLocationCount()

Return the number of the XmlGeoLocation.

Returns:

the size of this collection

removeAllGeoLocation

public void removeAllGeoLocation()

Remove all XmlGeoLocation in the List.

removeGeoLocation

public boolean removeGeoLocation(XmlGeoLocation geoLocation)

Remove a specified XmlGeoLocation.

Parameters:

geoLocation - the XmlGeoLocation to remove.

Returns:

true if the object was removed from the collection.

removeGeoLocationAt

public XmlGeoLocation removeGeoLocationAt(int index)

Remove a XmlGeoLocation at the specified position.

Parameters:

index - the position of the XmlGeoLocation to remove.

Returns:

the element removed from the collection

setGeoLocation

public void setGeoLocation(int index,
                           XmlGeoLocation geoLocation)
                    throws java.lang.IndexOutOfBoundsException

Set the XmlGeoLocation at the specified position of the List.

Parameters:

index - the position to set the XmlGeoLocation.

geoLocation - the XmlGeoLocation to set.

Throws:

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

setGeoLocation

public void setGeoLocation(XmlGeoLocation[] geoLocationArray)

Set a all XmlGeoLocation to the List.

Parameters:

geoLocationArray - the array of geolocations to set