Package org.opennms.netmgt.config.xmpDataCollection

Class XmpDatacollectionConfig

  • All Implemented Interfaces:
    java.io.Serializable
    public class XmpDatacollectionConfig
extends java.lang.Object
implements java.io.Serializable
    Top-level element for the xmp-datacollection-config.xml configuration file.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Detail

      • XmpDatacollectionConfig

        public XmpDatacollectionConfig()

    • Method Detail

      • addXmpCollection

        public void addXmpCollection​(XmpCollection vXmpCollection)
                      throws java.lang.IndexOutOfBoundsException
        Parameters:
        vXmpCollection -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addXmpCollection

        public void addXmpCollection​(int index,
                             XmpCollection vXmpCollection)
                      throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vXmpCollection -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • enumerateXmpCollection

        public java.util.Enumeration<XmpCollection> enumerateXmpCollection()
        Method enumerateXmpCollection.
        Returns:
        an Enumeration over all possible elements of this collection

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides the java.lang.Object.equals method.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj -
        Returns:
        true if the objects are equal.

      • getRrdRepository

        public java.lang.String getRrdRepository()
        Returns the value of field 'rrdRepository'. The field 'rrdRepository' has the following description: full path to the RRD repository for collected XMP data
        Returns:
        the value of field 'RrdRepository'.

      • getXmpCollection

        public XmpCollection getXmpCollection​(int index)
                               throws java.lang.IndexOutOfBoundsException
        Method getXmpCollection.
        Parameters:
        index -
        Returns:
        the value of the org.opennms.netmgt.config.xmpDataCollection.XmpCollection at the given index
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • getXmpCollection

        public XmpCollection[] getXmpCollection()
        Method getXmpCollection.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

      • getXmpCollectionCollection

        public java.util.List<XmpCollection> getXmpCollectionCollection()
        Method getXmpCollectionCollection.Returns a reference to '_xmpCollectionList'. No type checking is performed on any modifications to the Vector.
        Returns:
        a reference to the Vector backing this class

      • getXmpCollectionCount

        public int getXmpCollectionCount()
        Method getXmpCollectionCount.
        Returns:
        the size of this collection

      • hashCode

        public int hashCode()
        Overrides the java.lang.Object.hashCode method.

        The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for the object.

      • iterateXmpCollection

        public java.util.Iterator<XmpCollection> iterateXmpCollection()
        Method iterateXmpCollection.
        Returns:
        an Iterator over all possible elements in this collection

      • removeAllXmpCollection

        public void removeAllXmpCollection()

      • removeXmpCollection

        public boolean removeXmpCollection​(XmpCollection vXmpCollection)
        Method removeXmpCollection.
        Parameters:
        vXmpCollection -
        Returns:
        true if the object was removed from the collection.

      • removeXmpCollectionAt

        public XmpCollection removeXmpCollectionAt​(int index)
        Method removeXmpCollectionAt.
        Parameters:
        index -
        Returns:
        the element removed from the collection

      • setRrdRepository

        public void setRrdRepository​(java.lang.String rrdRepository)
        Sets the value of field 'rrdRepository'. The field 'rrdRepository' has the following description: full path to the RRD repository for collected XMP data
        Parameters:
        rrdRepository - the value of field 'rrdRepository'.

      • setXmpCollection

        public void setXmpCollection​(int index,
                             XmpCollection vXmpCollection)
                      throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vXmpCollection -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • setXmpCollection

        public void setXmpCollection​(XmpCollection[] vXmpCollectionArray)
        Parameters:
        vXmpCollectionArray -

      • setXmpCollection

        public void setXmpCollection​(java.util.List<XmpCollection> vXmpCollectionList)
        Sets the value of '_xmpCollectionList' by copying the given Vector. All elements will be checked for type safety.
        Parameters:
        vXmpCollectionList - the Vector to copy.

      • setXmpCollectionCollection

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