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

Class XmlRightsList

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmlRightsList() Default constructor
XmlRightsList(UntypedData elementValue)

Method Summary

Modifier and Type	Method and Description
void	addRights(int index, XmlRights rigths) Add a XmlRights to the List of XmlRights at a specified position.
void	addRights(XmlRights rights) Add a XmlRights to the List of XmlRights.
java.util.Iterator<? extends XmlRights>	enumerateRights() Return an Iterator of all XmlRights.
XmlRights[]	getRights() Returns the contents of the collection in an Array.
XmlRights	getRights(int index) Return the XmlRights at the specified position in the List.
int	getRightsCount() Return the number of the XmlRights.
void	removeAllRights() Remove all XmlRights in the List.
XmlRights	removeRightAt(int index) Remove a XmlRights at the specified position.
boolean	removeRights(XmlRights date) Remove a specified XmlRights.
void	setRights(int index, XmlRights rights) Set the XmlRights at the specified position of the List.
void	setRights(XmlRights[] rightsArray) Set a all XmlRights to the List.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlRightsList

public XmlRightsList()

Default constructor

XmlRightsList

public XmlRightsList(UntypedData elementValue)

Method Detail

addRights

public void addRights(XmlRights rights)
               throws java.lang.IndexOutOfBoundsException

Add a XmlRights to the List of XmlRights.

Parameters:

rights - the XmlRights to add.

Throws:

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

addRights

public void addRights(int index,
                      XmlRights rigths)
               throws java.lang.IndexOutOfBoundsException

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

Parameters:

index - the position to insert the XmlRights.

rigths - the XmlRights to add.

Throws:

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

enumerateRights

public java.util.Iterator<? extends XmlRights> enumerateRights()

Return an Iterator of all XmlRights.

Returns:

an Iterator over all XmlRights elements.

getRights

public XmlRights getRights(int index)
                    throws java.lang.IndexOutOfBoundsException

Return the XmlRights at the specified position in the List.

Parameters:

index - the position of the searched XmlRights.

Returns:

the value of the XmlRights at the given index

Throws:

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

getRights

public XmlRights[] getRights()

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

getRightsCount

public int getRightsCount()

Return the number of the XmlRights.

Returns:

the size of this collection

removeAllRights

public void removeAllRights()

Remove all XmlRights in the List.

removeRights

public boolean removeRights(XmlRights date)

Remove a specified XmlRights.

Parameters:

date - the XmlRights to remove.

Returns:

true if the object was removed from the collection.

removeRightAt

public XmlRights removeRightAt(int index)

Remove a XmlRights at the specified position.

Parameters:

index - the position of the XmlRights to remove.

Returns:

the element removed from the collection

setRights

public void setRights(int index,
                      XmlRights rights)
               throws java.lang.IndexOutOfBoundsException

Set the XmlRights at the specified position of the List.

Parameters:

index - the position to set the XmlRights.

rights - the XmlRights to set.

Throws:

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

setRights

public void setRights(XmlRights[] rightsArray)

Set a all XmlRights to the List.

Parameters:

rightsArray - the array of rights to set