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

Class XmlFormats

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

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

XML Mapping class for the 'formats' element.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
XmlFormats()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	addFormat(int index, java.lang.String format)	Add a XmlFormats to the List of XmlCreators at a specified position.
void	addFormat(java.lang.String format)	Add a XmlFormats to the List of XmlCreators.
java.util.Iterator<? extends java.lang.String>	enumerateFormat()	Return an Iterator of all XmlFormats.
java.lang.String[]	getFormat()	Returns the contents of the List in an Array.
java.lang.String	getFormat(int index)	Return the XmlFormats at the specified position in the List.
int	getFormatCount()	Return the number of the XmlFormats.
void	removeAllFormat()	Remove all XmlFormats in the List.
boolean	removeFormat(java.lang.String format)	Remove a specified XmlFormats.
java.lang.String	removeFormatAt(int index)	Remove a XmlFormats at the specified position.
void	setFormat(int index, java.lang.String format)	Set the XmlFormats at the specified position of the List.
void	setFormat(java.lang.String[] formatArray)	Set a all XmlFormats to the List.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlFormats

public XmlFormats()

Default constructor

Method Detail

addFormat

public void addFormat(java.lang.String format)
               throws java.lang.IndexOutOfBoundsException

Add a XmlFormats to the List of XmlCreators.

Parameters:

format - the XmlFormats to add.

Throws:

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

addFormat

public void addFormat(int index,
                      java.lang.String format)
               throws java.lang.IndexOutOfBoundsException

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

Parameters:

index - the position to insert the XmlFormats.

format - the XmlFormats to add.

Throws:

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

enumerateFormat

public java.util.Iterator<? extends java.lang.String> enumerateFormat()

Return an Iterator of all XmlFormats.

Returns:

an Iterator over all XmlFormats elements.

getFormat

public java.lang.String getFormat(int index)
                           throws java.lang.IndexOutOfBoundsException

Return the XmlFormats at the specified position in the List.

Parameters:

index - the position of the searched XmlFormats.

Returns:

the value of the XmlFormats at the given index

Throws:

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

getFormat

public java.lang.String[] getFormat()

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 XmlFormats.

getFormatCount

public int getFormatCount()

Return the number of the XmlFormats.

Returns:

the size of this collection

removeAllFormat

public void removeAllFormat()

Remove all XmlFormats in the List.

removeFormat

public boolean removeFormat(java.lang.String format)

Remove a specified XmlFormats.

Parameters:

format - the XmlFormats to remove.

Returns:

true if the object was removed from the collection.

removeFormatAt

public java.lang.String removeFormatAt(int index)

Remove a XmlFormats at the specified position.

Parameters:

index - the position of the XmlFormats to remove.

Returns:

the element removed from the collection

setFormat

public void setFormat(int index,
                      java.lang.String format)
               throws java.lang.IndexOutOfBoundsException

Set the XmlFormats at the specified position of the List.

Parameters:

index - the position to set the XmlFormats.

format - the XmlFormats to set.

Throws:

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

setFormat

public void setFormat(java.lang.String[] formatArray)

Set a all XmlFormats to the List.

Parameters:

formatArray - the array of formats to set