Package org.opennms.netmgt.config.xmpDataCollection

Class Group

  • All Implemented Interfaces:
    java.io.Serializable
    public class Group
extends java.lang.Object
implements java.io.Serializable
    a MIB object group
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Detail

      • Group

        public Group()

    • Method Detail

      • addIncludeGroup

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

      • addIncludeGroup

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

      • addMibObj

        public void addMibObj​(MibObj vMibObj)
               throws java.lang.IndexOutOfBoundsException
        Parameters:
        vMibObj -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addMibObj

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

      • enumerateIncludeGroup

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

      • enumerateMibObj

        public java.util.Enumeration<MibObj> enumerateMibObj()
        Method enumerateMibObj.
        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.

      • getIncludeGroup

        public java.lang.String getIncludeGroup​(int index)
                                 throws java.lang.IndexOutOfBoundsException
        Method getIncludeGroup.
        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

      • getIncludeGroup

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

      • getIncludeGroupCollection

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

      • getIncludeGroupCount

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

      • getMibObj

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

      • getMibObj

        public MibObj[] getMibObj()
        Method getMibObj.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

      • getMibObjCollection

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

      • getMibObjCount

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

      • getName

        public java.lang.String getName()
        Returns the value of field 'name'. The field 'name' has the following description: group name
        Returns:
        the value of field 'Name'.

      • getResourceType

        public java.lang.String getResourceType()
        Returns the value of field 'resourceType'. The field 'resourceType' has the following description: Name of resource or null if scalars. Resource type matches declaration in datacollection-config.xml for presentation in Web UI and in RRD storage. Each table, that is collected, should generally be given their own resource type. MIB2 tables, however, need not be given a separate resourceType as they are handled out-of-box by ONMS.
        Returns:
        the value of field 'ResourceType'.

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

      • iterateIncludeGroup

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

      • iterateMibObj

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

      • removeAllIncludeGroup

        public void removeAllIncludeGroup()

      • removeAllMibObj

        public void removeAllMibObj()

      • removeIncludeGroup

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

      • removeIncludeGroupAt

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

      • removeMibObj

        public boolean removeMibObj​(MibObj vMibObj)
        Method removeMibObj.
        Parameters:
        vMibObj -
        Returns:
        true if the object was removed from the collection.

      • removeMibObjAt

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

      • setIncludeGroup

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

      • setIncludeGroup

        public void setIncludeGroup​(java.lang.String[] vIncludeGroupArray)
        Parameters:
        vIncludeGroupArray -

      • setIncludeGroup

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

      • setIncludeGroupCollection

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

      • setMibObj

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

      • setMibObj

        public void setMibObj​(MibObj[] vMibObjArray)
        Parameters:
        vMibObjArray -

      • setMibObj

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

      • setMibObjCollection

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

      • setName

        public void setName​(java.lang.String name)
        Sets the value of field 'name'. The field 'name' has the following description: group name
        Parameters:
        name - the value of field 'name'.

      • setResourceType

        public void setResourceType​(java.lang.String resourceType)
        Sets the value of field 'resourceType'. The field 'resourceType' has the following description: Name of resource or null if scalars. Resource type matches declaration in datacollection-config.xml for presentation in Web UI and in RRD storage. Each table, that is collected, should generally be given their own resource type. MIB2 tables, however, need not be given a separate resourceType as they are handled out-of-box by ONMS.
        Parameters:
        resourceType - the value of field 'resourceType'.