Class XmlTitles

  • All Implemented Interfaces:
    java.io.Serializable

    public class XmlTitles
    extends java.lang.Object
    implements java.io.Serializable
    XML mapping class for the 'titles' element.
    See Also:
    Serialized Form
    • Constructor Detail

      • XmlTitles

        public XmlTitles()
        Default constructor.
    • Method Detail

      • addTitle

        public void addTitle​(XmlTitle title)
                      throws java.lang.IndexOutOfBoundsException
        Add a XmlTitle to the List of XmlTitle.
        Parameters:
        title - the XmlTitle to add.
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection.
      • addTitle

        public void addTitle​(int index,
                             XmlTitle title)
                      throws java.lang.IndexOutOfBoundsException
        Add a XmlTitle to the List of XmlTitle at a specified position.
        Parameters:
        index - the position to insert the XmlTitle.
        title - the XmlTitle to add.
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
      • enumerateTitle

        public java.util.Iterator<? extends XmlTitle> enumerateTitle()
        Return an Iterator of all XmlTitle.
        Returns:
        an Iterator over all XmlTitle elements.
      • getTitle

        public XmlTitle getTitle​(int index)
                          throws java.lang.IndexOutOfBoundsException
        Return the XmlTitle at the specified position in the List .
        Parameters:
        index - the position of the searched XmlTitle.
        Returns:
        the value of the XmlTitle at the given index
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
      • getTitle

        public XmlTitle[] getTitle()
        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
      • getTitleCount

        public int getTitleCount()
        Return the number of the XmlTitle.
        Returns:
        the size of this collection
      • removeAllTitle

        public void removeAllTitle()
        Remove all XmlTitle in the List.
      • removeTitle

        public boolean removeTitle​(XmlTitle title)
        Remove a specified XmlTitle.
        Parameters:
        title - the XmlTitle to remove.
        Returns:
        true if the object was removed from the collection.
      • removeTitleAt

        public XmlTitle removeTitleAt​(int index)
        Remove a XmlTitle at the specified position.
        Parameters:
        index - the position of the XmlTitle to remove.
        Returns:
        the element removed from the collection
      • setTitle

        public void setTitle​(int index,
                             XmlTitle title)
                      throws java.lang.IndexOutOfBoundsException
        Set the XmlTitle at the specified position of the List.
        Parameters:
        title - the position to set the XmlTitle.
        index - the position to set.
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
      • setTitle

        public void setTitle​(XmlTitle[] titleArray)
        Set a all XmlTitle to the List.
        Parameters:
        titleArray - the array of titles to set