org.opennms.netmgt.config.vmware.cim

Class VmwareCimCollection

java.lang.Object

org.opennms.netmgt.config.vmware.cim.VmwareCimCollection

All Implemented Interfaces:

Serializable

public class VmwareCimCollection
extends Object
implements Serializable

A grouping of VMware related RRD parms and performance counter groups

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VmwareCimCollection()

Method Summary

Modifier and Type	Method and Description
void	addVmwareCimGroup(int index, VmwareCimGroup vVmwareCimGroup)
void	addVmwareCimGroup(VmwareCimGroup vVmwareCimGroup)
Enumeration<VmwareCimGroup>	enumerateVmwareCimGroup() Method enumerateVmwareCimGroup.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getName() Returns the value of field 'name'.
Rrd	getRrd() Returns the value of field 'rrd'.
VmwareCimGroup[]	getVmwareCimGroup() Method getVmwareCimGroup.Returns the contents of the collection in an Array.
VmwareCimGroup	getVmwareCimGroup(int index) Method getVmwareCimGroup.
List<VmwareCimGroup>	getVmwareCimGroupCollection() Method getVmwareCimGroupCollection.Returns a reference to '_vmwareCimGroupList'.
int	getVmwareCimGroupCount() Method getVmwareCimGroupCount.
Iterator<VmwareCimGroup>	iterateVmwareCimGroup() Method iterateVmwareCimGroup.
void	removeAllVmwareCimGroup()
boolean	removeVmwareCimGroup(VmwareCimGroup vVmwareCimGroup) Method removeVmwareCimGroup.
VmwareCimGroup	removeVmwareCimGroupAt(int index) Method removeVmwareCimGroupAt.
void	setName(String name) Sets the value of field 'name'.
void	setRrd(Rrd rrd) Sets the value of field 'rrd'.
void	setVmwareCimGroup(int index, VmwareCimGroup vVmwareCimGroup)
void	setVmwareCimGroup(List<VmwareCimGroup> vVmwareCimGroupList) Sets the value of '_vmwareCimGroupList' by copying the given Vector.
void	setVmwareCimGroup(VmwareCimGroup[] vVmwareCimGroupArray)

Methods inherited from class java.lang.Object

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

Constructor Detail

VmwareCimCollection

public VmwareCimCollection()

Method Detail

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.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getRrd

public Rrd getRrd()

Returns the value of field 'rrd'. The field 'rrd' has the following description: RRD parms

Returns:

the value of field 'Rrd'.

addVmwareCimGroup

public void addVmwareCimGroup(VmwareCimGroup vVmwareCimGroup)
                       throws IndexOutOfBoundsException

Parameters:

vVmwareCimGroup -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addVmwareCimGroup

public void addVmwareCimGroup(int index,
                              VmwareCimGroup vVmwareCimGroup)
                       throws IndexOutOfBoundsException

Parameters:

index -

vVmwareCimGroup -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateVmwareCimGroup

public Enumeration<VmwareCimGroup> enumerateVmwareCimGroup()

Method enumerateVmwareCimGroup.

Returns:

an Enumeration over all possible elements of this collection

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setRrd

public void setRrd(Rrd rrd)

Sets the value of field 'rrd'. The field 'rrd' has the following description: RRD parms

Parameters:

rrd - the value of field 'rrd'.

getVmwareCimGroup

public VmwareCimGroup getVmwareCimGroup(int index)
                                 throws IndexOutOfBoundsException

Method getVmwareCimGroup.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.vmware.cim.VmwareCimGroup at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getVmwareCimGroup

public VmwareCimGroup[] getVmwareCimGroup()

Method getVmwareCimGroup.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

getVmwareCimGroupCollection

public List<VmwareCimGroup> getVmwareCimGroupCollection()

Method getVmwareCimGroupCollection.Returns a reference to '_vmwareCimGroupList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getVmwareCimGroupCount

public int getVmwareCimGroupCount()

Method getVmwareCimGroupCount.

Returns:

the size of this collection

iterateVmwareCimGroup

public Iterator<VmwareCimGroup> iterateVmwareCimGroup()

Method iterateVmwareCimGroup.

Returns:

an Iterator over all possible elements in this collection

removeAllVmwareCimGroup

public void removeAllVmwareCimGroup()

removeVmwareCimGroup

public boolean removeVmwareCimGroup(VmwareCimGroup vVmwareCimGroup)

Method removeVmwareCimGroup.

Parameters:

vVmwareCimGroup -

Returns:

true if the object was removed from the collection.

removeVmwareCimGroupAt

public VmwareCimGroup removeVmwareCimGroupAt(int index)

Method removeVmwareCimGroupAt.

Parameters:

index -

Returns:

the element removed from the collection

setVmwareCimGroup

public void setVmwareCimGroup(int index,
                              VmwareCimGroup vVmwareCimGroup)
                       throws IndexOutOfBoundsException

Parameters:

index -

vVmwareCimGroup -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setVmwareCimGroup

public void setVmwareCimGroup(VmwareCimGroup[] vVmwareCimGroupArray)

Parameters:

vVmwareCimGroupArray -

setVmwareCimGroup

public void setVmwareCimGroup(List<VmwareCimGroup> vVmwareCimGroupList)

Sets the value of '_vmwareCimGroupList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vVmwareCimGroupList - the Vector to copy.