Class Col

  • All Implemented Interfaces:
    java.io.Serializable

    public class Col
    extends java.lang.Object
    implements java.io.Serializable
    Class Col.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Col()  
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addColTitle​(int index, java.lang.String vColTitle)  
      void addColTitle​(java.lang.String vColTitle)  
      java.util.Enumeration<java.lang.String> enumerateColTitle()
      Method enumerateColTitle.
      java.lang.String[] getColTitle()
      Method getColTitle.Returns the contents of the collection in an Array.
      java.lang.String getColTitle​(int index)
      Method getColTitle.
      java.util.List<java.lang.String> getColTitleCollection()
      Method getColTitleCollection.Returns a reference to 'colTitleList'.
      int getColTitleCount()
      Method getColTitleCount.
      java.util.Iterator<java.lang.String> iterateColTitle()
      Method iterateColTitle.
      void removeAllColTitle()  
      boolean removeColTitle​(java.lang.String vColTitle)
      Method removeColTitle.
      java.lang.String removeColTitleAt​(int index)
      Method removeColTitleAt.
      void setColTitle​(int index, java.lang.String vColTitle)  
      void setColTitle​(java.lang.String[] vColTitleArray)  
      void setColTitle​(java.util.List<java.lang.String> vColTitleList)
      Sets the value of 'colTitleList' by copying the given Vector.
      void setColTitleCollection​(java.util.List<java.lang.String> colTitleList)
      Deprecated. 
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Col

        public Col()
    • Method Detail

      • addColTitle

        public void addColTitle​(java.lang.String vColTitle)
                         throws java.lang.IndexOutOfBoundsException
        Parameters:
        vColTitle -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
      • addColTitle

        public void addColTitle​(int index,
                                java.lang.String vColTitle)
                         throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vColTitle -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
      • enumerateColTitle

        public java.util.Enumeration<java.lang.String> enumerateColTitle()
        Method enumerateColTitle.
        Returns:
        an Enumeration over all possible elements of this collection
      • getColTitle

        public java.lang.String getColTitle​(int index)
                                     throws java.lang.IndexOutOfBoundsException
        Method getColTitle.
        Parameters:
        index -
        Returns:
        the value of the String at the given index
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
      • getColTitle

        public java.lang.String[] getColTitle()
        Method getColTitle.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
      • getColTitleCollection

        public java.util.List<java.lang.String> getColTitleCollection()
        Method getColTitleCollection.Returns a reference to 'colTitleList'. No type checking is performed on any modifications to the Vector.
        Returns:
        a reference to the Vector backing this class
      • getColTitleCount

        public int getColTitleCount()
        Method getColTitleCount.
        Returns:
        the size of this collection
      • iterateColTitle

        public java.util.Iterator<java.lang.String> iterateColTitle()
        Method iterateColTitle.
        Returns:
        an Iterator over all possible elements in this collection
      • removeAllColTitle

        public void removeAllColTitle()
      • removeColTitle

        public boolean removeColTitle​(java.lang.String vColTitle)
        Method removeColTitle.
        Parameters:
        vColTitle -
        Returns:
        true if the object was removed from the collection.
      • removeColTitleAt

        public java.lang.String removeColTitleAt​(int index)
        Method removeColTitleAt.
        Parameters:
        index -
        Returns:
        the element removed from the collection
      • setColTitle

        public void setColTitle​(int index,
                                java.lang.String vColTitle)
                         throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vColTitle -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection
      • setColTitle

        public void setColTitle​(java.lang.String[] vColTitleArray)
        Parameters:
        vColTitleArray -
      • setColTitle

        public void setColTitle​(java.util.List<java.lang.String> vColTitleList)
        Sets the value of 'colTitleList' by copying the given Vector. All elements will be checked for type safety.
        Parameters:
        vColTitleList - the Vector to copy.
      • setColTitleCollection

        public void setColTitleCollection​(java.util.List<java.lang.String> colTitleList)
        Deprecated.
        Sets the value of 'colTitleList' by setting it to the given Vector. No type checking is performed.
        Parameters:
        colTitleList - the Vector to set.