VmwareCimGroup (OpenNMS 2021.1.1 API)

java.lang.Object
- org.opennms.netmgt.config.vmware.cim.VmwareCimGroup

All Implemented Interfaces:

Serializable
```
public class VmwareCimGroup
extends Object
implements Serializable
```
An VMware Cim Object Group

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

VmwareCimGroup()

Constructors
Constructor and Description
`VmwareCimGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttrib(Attrib vAttrib)`
`void`	`addAttrib(int index, Attrib vAttrib)`
`Enumeration<Attrib>`	`enumerateAttrib()` Method enumerateAttrib.
`boolean`	`equals(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.
`List<Attrib>`	`getAttribCollection()` Method getAttribCollection.Returns a reference to '_attribList'.
`int`	`getAttribCount()` Method getAttribCount.
`String`	`getCimClass()` Returns the value of field 'cimClass'.
`String`	`getInstance()` Returns the value of field 'instance'.
`String`	`getKey()` Returns the value of field 'key'.
`String`	`getName()` Returns the value of field 'name'.
`String`	`getResourceType()` Returns the value of field 'resourceType'.
`String`	`getValue()` Returns the value of field 'value'.
`Iterator<Attrib>`	`iterateAttrib()` Method iterateAttrib.
`void`	`removeAllAttrib()`
`boolean`	`removeAttrib(Attrib vAttrib)` Method removeAttrib.
`Attrib`	`removeAttribAt(int index)` Method removeAttribAt.
`void`	`setAttrib(Attrib[] vAttribArray)`
`void`	`setAttrib(int index, Attrib vAttrib)`
`void`	`setAttrib(List<Attrib> vAttribList)` Sets the value of '_attribList' by copying the given Vector.
`void`	`setCimClass(String cimClass)` Sets the value of field 'cimClass'.
`void`	`setInstance(String instance)` Sets the value of field 'instance'.
`void`	`setKey(String key)` Sets the value of field 'key'.
`void`	`setName(String name)` Sets the value of field 'name'.
`void`	`setResourceType(String resourceType)` Sets the value of field 'resourceType'.
`void`	`setValue(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 IndexOutOfBoundsException
```
    Parameters:
    
    vAttrib -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addAttrib
```
public void addAttrib(int index,
                      Attrib vAttrib)
               throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vAttrib -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - enumerateAttrib
```
public Enumeration<Attrib> enumerateAttrib()
```
    Method enumerateAttrib.
    
    Returns:
    
    an Enumeration over all possible elements of this collection
  - equals
```
public boolean equals(Object obj)
```
    Overrides the java.lang.Object.equals method.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    true if the objects are equal.
  - getAttrib
```
public Attrib getAttrib(int index)
                 throws IndexOutOfBoundsException
```
    Method getAttrib.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the org.opennms.netmgt.config.vmware.cim.Attrib at the given inde
    
    Throws:
    
    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 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 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 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 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 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 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 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 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 IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vAttrib -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setAttrib
```
public void setAttrib(Attrib[] vAttribArray)
```
    Parameters:
    
    vAttribArray -
  - setAttrib
```
public void setAttrib(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(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(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(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(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(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(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'.

Class VmwareCimGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VmwareCimGroup

Method Detail

addAttrib

addAttrib

enumerateAttrib

equals

getAttrib

getAttrib

getAttribCollection

getAttribCount

getCimClass

getInstance

getKey

getName

getResourceType

getValue

iterateAttrib

removeAllAttrib

removeAttrib

removeAttribAt

setAttrib

setAttrib

setAttrib

setCimClass

setInstance

setKey

setName

setResourceType

setValue