org.opennms.netmgt.config.vmware.vijava

Class VmwareCollection

java.lang.Object

org.opennms.netmgt.config.vmware.vijava.VmwareCollection

All Implemented Interfaces:

Serializable

public class VmwareCollection
extends Object
implements Serializable

A grouping of VMware related RRD parms and performance counter groups

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VmwareCollection()

Method Summary

Methods

Modifier and Type	Method and Description
void	addVmwareGroup(int index, VmwareGroup vVmwareGroup)
void	addVmwareGroup(VmwareGroup vVmwareGroup)
Enumeration<VmwareGroup>	enumerateVmwareGroup() Method enumerateVmwareGroup.
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'.
VmwareGroup[]	getVmwareGroup() Method getVmwareGroup.Returns the contents of the collection in an Array.
VmwareGroup	getVmwareGroup(int index) Method getVmwareGroup.
List<VmwareGroup>	getVmwareGroupCollection() Method getVmwareGroupCollection.Returns a reference to '_vmwareGroupList'.
int	getVmwareGroupCount() Method getVmwareGroupCount.
Iterator<VmwareGroup>	iterateVmwareGroup() Method iterateVmwareGroup.
void	removeAllVmwareGroup()
boolean	removeVmwareGroup(VmwareGroup vVmwareGroup) Method removeVmwareGroup.
VmwareGroup	removeVmwareGroupAt(int index) Method removeVmwareGroupAt.
void	setName(String name) Sets the value of field 'name'.
void	setRrd(Rrd rrd) Sets the value of field 'rrd'.
void	setVmwareGroup(int index, VmwareGroup vVmwareGroup)
void	setVmwareGroup(List<VmwareGroup> vVmwareGroupList) Sets the value of '_vmwareGroupList' by copying the given Vector.
void	setVmwareGroup(VmwareGroup[] vVmwareGroupArray)

Methods inherited from class java.lang.Object

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

Constructor Detail

VmwareCollection

public VmwareCollection()

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

addVmwareGroup

public void addVmwareGroup(VmwareGroup vVmwareGroup)
                    throws IndexOutOfBoundsException

Parameters:

vVmwareGroup -

Throws:

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

addVmwareGroup

public void addVmwareGroup(int index,
                  VmwareGroup vVmwareGroup)
                    throws IndexOutOfBoundsException

Parameters:

index -

vVmwareGroup -

Throws:

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

enumerateVmwareGroup

public Enumeration<VmwareGroup> enumerateVmwareGroup()

Method enumerateVmwareGroup.

Returns:

an Enumeration over all possible elements of this collection

getVmwareGroup

public VmwareGroup getVmwareGroup(int index)
                           throws IndexOutOfBoundsException

Method getVmwareGroup.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.vmware.vijava.VmwareGroup at the given index

Throws:

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

getVmwareGroup

public VmwareGroup[] getVmwareGroup()

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

getVmwareGroupCollection

public List<VmwareGroup> getVmwareGroupCollection()

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

Returns:

a reference to the Vector backing this class

getVmwareGroupCount

public int getVmwareGroupCount()

Method getVmwareGroupCount.

Returns:

the size of this collection

iterateVmwareGroup

public Iterator<VmwareGroup> iterateVmwareGroup()

Method iterateVmwareGroup.

Returns:

an Iterator over all possible elements in this collection

removeAllVmwareGroup

public void removeAllVmwareGroup()

removeVmwareGroup

public boolean removeVmwareGroup(VmwareGroup vVmwareGroup)

Method removeVmwareGroup.

Parameters:

vVmwareGroup -

Returns:

true if the object was removed from the collection.

removeVmwareGroupAt

public VmwareGroup removeVmwareGroupAt(int index)

Method removeVmwareGroupAt.

Parameters:

index -

Returns:

the element removed from the collection

setVmwareGroup

public void setVmwareGroup(int index,
                  VmwareGroup vVmwareGroup)
                    throws IndexOutOfBoundsException

Parameters:

index -

vVmwareGroup -

Throws:

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

setVmwareGroup

public void setVmwareGroup(VmwareGroup[] vVmwareGroupArray)

Parameters:

vVmwareGroupArray -

setVmwareGroup

public void setVmwareGroup(List<VmwareGroup> vVmwareGroupList)

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

Parameters:

vVmwareGroupList - the Vector to copy.

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