Package org.opennms.netmgt.config.xmpDataCollection

Class Rrd

  • All Implemented Interfaces:
    java.io.Serializable
    public class Rrd
extends java.lang.Object
implements java.io.Serializable
    RRD parms
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Rrd()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addRra​(int index, java.lang.String vRra)  
      void addRra​(java.lang.String vRra)  
      void deleteStep()  
      java.util.Enumeration<java.lang.String> enumerateRra()
      Method enumerateRra.
      boolean equals​(java.lang.Object obj)
      Overrides the java.lang.Object.equals method.
      java.lang.String[] getRra()
      Method getRra.Returns the contents of the collection in an Array.
      java.lang.String getRra​(int index)
      Method getRra.
      java.util.List<java.lang.String> getRraCollection()
      Method getRraCollection.Returns a reference to '_rraList'.
      int getRraCount()
      Method getRraCount.
      int getStep()
      Returns the value of field 'step'.
      int hashCode()
      Overrides the java.lang.Object.hashCode method.
      boolean hasStep()
      Method hasStep.
      java.util.Iterator<java.lang.String> iterateRra()
      Method iterateRra.
      void removeAllRra()  
      boolean removeRra​(java.lang.String vRra)
      Method removeRra.
      java.lang.String removeRraAt​(int index)
      Method removeRraAt.
      void setRra​(int index, java.lang.String vRra)  
      void setRra​(java.lang.String[] vRraArray)  
      void setRra​(java.util.List<java.lang.String> vRraList)
      Sets the value of '_rraList' by copying the given Vector.
      void setRraCollection​(java.util.List<java.lang.String> rraList)
      Deprecated. 
      void setStep​(int step)
      Sets the value of field 'step'.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Rrd

        public Rrd()

    • Method Detail

      • addRra

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

      • addRra

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

      • deleteStep

        public void deleteStep()

      • enumerateRra

        public java.util.Enumeration<java.lang.String> enumerateRra()
        Method enumerateRra.
        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.

      • getRra

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

      • getRra

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

      • getRraCollection

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

      • getRraCount

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

      • getStep

        public int getStep()
        Returns the value of field 'step'. The field 'step' has the following description: step size for the RRD
        Returns:
        the value of field 'Step'.

      • hasStep

        public boolean hasStep()
        Method hasStep.
        Returns:
        true if at least one Step has been added

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

      • iterateRra

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

      • removeAllRra

        public void removeAllRra()

      • removeRra

        public boolean removeRra​(java.lang.String vRra)
        Method removeRra.
        Parameters:
        vRra -
        Returns:
        true if the object was removed from the collection.

      • removeRraAt

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

      • setRra

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

      • setRra

        public void setRra​(java.lang.String[] vRraArray)
        Parameters:
        vRraArray -

      • setRra

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

      • setRraCollection

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

      • setStep

        public void setStep​(int step)
        Sets the value of field 'step'. The field 'step' has the following description: step size for the RRD
        Parameters:
        step - the value of field 'step'.