Package org.opennms.netmgt.config.vmware.cim

Class VmwareCimGroup

  • All Implemented Interfaces:
    java.io.Serializable
    public class VmwareCimGroup
extends java.lang.Object
implements java.io.Serializable
    An VMware Cim Object Group
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      VmwareCimGroup()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAttrib​(int index, Attrib vAttrib)  
      void addAttrib​(Attrib vAttrib)  
      java.util.Enumeration<Attrib> enumerateAttrib()
      Method enumerateAttrib.
      boolean equals​(java.lang.Object obj)
      Overrides the java.lang.Object.equals method.
      Attrib[] getAttrib()
      Method getAttrib.Returns the contents of the collection in an Array.
      Attrib getAttrib​(int index)
      Method getAttrib.
      java.util.List<Attrib> getAttribCollection()
      Method getAttribCollection.Returns a reference to '_attribList'.
      int getAttribCount()
      Method getAttribCount.
      java.lang.String getCimClass()
      Returns the value of field 'cimClass'.
      java.lang.String getInstance()
      Returns the value of field 'instance'.
      java.lang.String getKey()
      Returns the value of field 'key'.
      java.lang.String getName()
      Returns the value of field 'name'.
      java.lang.String getResourceType()
      Returns the value of field 'resourceType'.
      java.lang.String getValue()
      Returns the value of field 'value'.
      java.util.Iterator<Attrib> iterateAttrib()
      Method iterateAttrib.
      void removeAllAttrib()  
      boolean removeAttrib​(Attrib vAttrib)
      Method removeAttrib.
      Attrib removeAttribAt​(int index)
      Method removeAttribAt.
      void setAttrib​(int index, Attrib vAttrib)  
      void setAttrib​(java.util.List<Attrib> vAttribList)
      Sets the value of '_attribList' by copying the given Vector.
      void setAttrib​(Attrib[] vAttribArray)  
      void setCimClass​(java.lang.String cimClass)
      Sets the value of field 'cimClass'.
      void setInstance​(java.lang.String instance)
      Sets the value of field 'instance'.
      void setKey​(java.lang.String key)
      Sets the value of field 'key'.
      void setName​(java.lang.String name)
      Sets the value of field 'name'.
      void setResourceType​(java.lang.String resourceType)
      Sets the value of field 'resourceType'.
      void setValue​(java.lang.String value)
      Sets the value of field 'value'.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • VmwareCimGroup

        public VmwareCimGroup()

    • Method Detail

      • addAttrib

        public void addAttrib​(Attrib vAttrib)
               throws java.lang.IndexOutOfBoundsException
        Parameters:
        vAttrib -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addAttrib

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

      • enumerateAttrib

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

      • getAttrib

        public Attrib getAttrib​(int index)
                 throws java.lang.IndexOutOfBoundsException
        Method getAttrib.
        Parameters:
        index -
        Returns:
        the value of the org.opennms.netmgt.config.vmware.cim.Attrib at the given inde
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • getAttrib

        public Attrib[] getAttrib()
        Method getAttrib.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

      • getAttribCollection

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

      • getAttribCount

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

      • getCimClass

        public java.lang.String getCimClass()
        Returns the value of field 'cimClass'. The field 'cimClass' has the following description: The name of the Cmi class to query
        Returns:
        the value of field 'CimClass'.

      • getInstance

        public java.lang.String getInstance()
        Returns the value of field 'instance'. The field 'instance' has the following description: The instance attribute of this group
        Returns:
        the value of field 'Instance'.

      • getKey

        public java.lang.String getKey()
        Returns the value of field 'key'. The field 'key' has the following description: The attibute with name Key will be checked against Value
        Returns:
        the value of field 'Key'.

      • getName

        public java.lang.String getName()
        Returns the value of field 'name'. The field 'name' has the following description: The name of this group, for user id purposes
        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: Specifies the name of the resource type that pertains to the attributes in this group. For scalar attributes (those occurring once per node, such as available system memory) this should be "node". For multi-instanced attributes, this should be the name of a custom resource type declared in datacollection-config.xml.
        Returns:
        the value of field 'ResourceType'.

      • getValue

        public java.lang.String getValue()
        Returns the value of field 'value'. The field 'value' has the following description: The attibute with name Key will be checked against Value
        Returns:
        the value of field 'Value'.

      • iterateAttrib

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

      • removeAllAttrib

        public void removeAllAttrib()

      • removeAttrib

        public boolean removeAttrib​(Attrib vAttrib)
        Method removeAttrib.
        Parameters:
        vAttrib -
        Returns:
        true if the object was removed from the collection.

      • removeAttribAt

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

      • setAttrib

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

      • setAttrib

        public void setAttrib​(Attrib[] vAttribArray)
        Parameters:
        vAttribArray -

      • setAttrib

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

      • setCimClass

        public void setCimClass​(java.lang.String cimClass)
        Sets the value of field 'cimClass'. The field 'cimClass' has the following description: The name of the Cmi class to query
        Parameters:
        cimClass - the value of field 'cimClass'.

      • setInstance

        public void setInstance​(java.lang.String instance)
        Sets the value of field 'instance'. The field 'instance' has the following description: The instance attribute of this group
        Parameters:
        instance - the value of field 'instance'.

      • setKey

        public void setKey​(java.lang.String key)
        Sets the value of field 'key'. The field 'key' has the following description: The attibute with name Key will be checked against Value
        Parameters:
        key - the value of field 'key'.

      • setName

        public void setName​(java.lang.String name)
        Sets the value of field 'name'. The field 'name' has the following description: The name of this group, for user id purposes
        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: Specifies the name of the resource type that pertains to the attributes in this group. For scalar attributes (those occurring once per node, such as available system memory) this should be "node". For multi-instanced attributes, this should be the name of a custom resource type declared in datacollection-config.xml.
        Parameters:
        resourceType - the value of field 'resourceType'.

      • setValue

        public void setValue​(java.lang.String value)
        Sets the value of field 'value'. The field 'value' has the following description: The attibute with name Key will be checked against Value
        Parameters:
        value - the value of field 'value'.