org.opennms.netmgt.config.vmware

Class VmwareConfig

java.lang.Object

org.opennms.netmgt.config.vmware.VmwareConfig

All Implemented Interfaces:

Serializable

public class VmwareConfig
extends Object
implements Serializable

This is the top-level element for vmware-config.xml

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VmwareConfig()

Method Summary

Modifier and Type	Method and Description
void	addVmwareServer(int index, VmwareServer vVmwareServer)
void	addVmwareServer(VmwareServer vVmwareServer)
Enumeration<VmwareServer>	enumerateVmwareServer() Method enumerateVmwareServer.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
VmwareServer[]	getVmwareServer() Method getVmwareServer.Returns the contents of the collection in an Array.
VmwareServer	getVmwareServer(int index) Method getVmwareServer.
List<VmwareServer>	getVmwareServerCollection() Method getVmwareServerCollection.Returns a reference to '_vmwareServerList'.
int	getVmwareServerCount() Method getVmwareServerCount.
Iterator<VmwareServer>	iterateVmwareServer() Method iterateVmwareServer.
void	removeAllVmwareServer()
boolean	removeVmwareServer(VmwareServer vVmwareServer) Method removeVmwareServer.
VmwareServer	removeVmwareServerAt(int index) Method removeVmwareServerAt.
void	setVmwareServer(int index, VmwareServer vVmwareServer)
void	setVmwareServer(List<VmwareServer> vVmwareServerList) Sets the value of '_vmwareServerList' by copying the given Vector.
void	setVmwareServer(VmwareServer[] vVmwareServerArray)

Methods inherited from class java.lang.Object

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

Constructor Detail

VmwareConfig

public VmwareConfig()

Method Detail

addVmwareServer

public void addVmwareServer(VmwareServer vVmwareServer)
                     throws IndexOutOfBoundsException

Parameters:

vVmwareServer -

Throws:

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

addVmwareServer

public void addVmwareServer(int index,
                            VmwareServer vVmwareServer)
                     throws IndexOutOfBoundsException

Parameters:

index -

vVmwareServer -

Throws:

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

enumerateVmwareServer

public Enumeration<VmwareServer> enumerateVmwareServer()

Method enumerateVmwareServer.

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.

getVmwareServer

public VmwareServer getVmwareServer(int index)
                             throws IndexOutOfBoundsException

Method getVmwareServer.

Parameters:

index -

Returns:

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

Throws:

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

getVmwareServer

public VmwareServer[] getVmwareServer()

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

getVmwareServerCollection

public List<VmwareServer> getVmwareServerCollection()

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

Returns:

a reference to the Vector backing this class

getVmwareServerCount

public int getVmwareServerCount()

Method getVmwareServerCount.

Returns:

the size of this collection

iterateVmwareServer

public Iterator<VmwareServer> iterateVmwareServer()

Method iterateVmwareServer.

Returns:

an Iterator over all possible elements in this collection

removeAllVmwareServer

public void removeAllVmwareServer()

removeVmwareServer

public boolean removeVmwareServer(VmwareServer vVmwareServer)

Method removeVmwareServer.

Parameters:

vVmwareServer -

Returns:

true if the object was removed from the collection.

removeVmwareServerAt

public VmwareServer removeVmwareServerAt(int index)

Method removeVmwareServerAt.

Parameters:

index -

Returns:

the element removed from the collection

setVmwareServer

public void setVmwareServer(int index,
                            VmwareServer vVmwareServer)
                     throws IndexOutOfBoundsException

Parameters:

index -

vVmwareServer -

Throws:

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

setVmwareServer

public void setVmwareServer(VmwareServer[] vVmwareServerArray)

Parameters:

vVmwareServerArray -

setVmwareServer

public void setVmwareServer(List<VmwareServer> vVmwareServerList)

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

Parameters:

vVmwareServerList - the Vector to copy.