org.opennms.netmgt.config.wmi

Class WmiDatacollectionConfig

java.lang.Object

org.opennms.netmgt.config.wmi.WmiDatacollectionConfig

All Implemented Interfaces:

Serializable

public class WmiDatacollectionConfig
extends Object
implements Serializable

Class WmiDatacollectionConfig.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WmiDatacollectionConfig()

Method Summary

Modifier and Type	Method and Description
void	addWmiCollection(int index, WmiCollection vWmiCollection)
void	addWmiCollection(WmiCollection vWmiCollection)
Enumeration<WmiCollection>	enumerateWmiCollection() Method enumerateWmiCollection.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getRrdRepository() Returns the value of field 'rrdRepository'.
WmiCollection[]	getWmiCollection() Method getWmiCollection.Returns the contents of the collection in an Array.
WmiCollection	getWmiCollection(int index) Method getWmiCollection.
List<WmiCollection>	getWmiCollectionCollection() Method getWmiCollectionCollection.Returns a reference to '_wmiCollectionList'.
int	getWmiCollectionCount() Method getWmiCollectionCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<WmiCollection>	iterateWmiCollection() Method iterateWmiCollection.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllWmiCollection()
boolean	removeWmiCollection(WmiCollection vWmiCollection) Method removeWmiCollection.
WmiCollection	removeWmiCollectionAt(int index) Method removeWmiCollectionAt.
void	setRrdRepository(String rrdRepository) Sets the value of field 'rrdRepository'.
void	setWmiCollection(int index, WmiCollection vWmiCollection)
void	setWmiCollection(List<WmiCollection> vWmiCollectionList) Sets the value of '_wmiCollectionList' by copying the given Vector.
void	setWmiCollection(WmiCollection[] vWmiCollectionArray)
void	setWmiCollectionCollection(List<WmiCollection> wmiCollectionList) Deprecated.
static WmiDatacollectionConfig	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

WmiDatacollectionConfig

public WmiDatacollectionConfig()

Method Detail

addWmiCollection

public void addWmiCollection(WmiCollection vWmiCollection)
                      throws IndexOutOfBoundsException

Parameters:

vWmiCollection -

Throws:

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

addWmiCollection

public void addWmiCollection(int index,
                             WmiCollection vWmiCollection)
                      throws IndexOutOfBoundsException

Parameters:

index -

vWmiCollection -

Throws:

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

enumerateWmiCollection

public Enumeration<WmiCollection> enumerateWmiCollection()

Method enumerateWmiCollection.

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.

getRrdRepository

public String getRrdRepository()

Returns the value of field 'rrdRepository'.

Returns:

the value of field 'RrdRepository'.

getWmiCollection

public WmiCollection getWmiCollection(int index)
                               throws IndexOutOfBoundsException

Method getWmiCollection.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.wmi.WmiCollection at the given inde

Throws:

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

getWmiCollection

public WmiCollection[] getWmiCollection()

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

getWmiCollectionCollection

public List<WmiCollection> getWmiCollectionCollection()

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

Returns:

a reference to the Vector backing this class

getWmiCollectionCount

public int getWmiCollectionCount()

Method getWmiCollectionCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateWmiCollection

public Iterator<WmiCollection> iterateWmiCollection()

Method iterateWmiCollection.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllWmiCollection

public void removeAllWmiCollection()

removeWmiCollection

public boolean removeWmiCollection(WmiCollection vWmiCollection)

Method removeWmiCollection.

Parameters:

vWmiCollection -

Returns:

true if the object was removed from the collection.

removeWmiCollectionAt

public WmiCollection removeWmiCollectionAt(int index)

Method removeWmiCollectionAt.

Parameters:

index -

Returns:

the element removed from the collection

setRrdRepository

public void setRrdRepository(String rrdRepository)

Sets the value of field 'rrdRepository'.

Parameters:

rrdRepository - the value of field 'rrdRepository'.

setWmiCollection

public void setWmiCollection(int index,
                             WmiCollection vWmiCollection)
                      throws IndexOutOfBoundsException

Parameters:

index -

vWmiCollection -

Throws:

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

setWmiCollection

public void setWmiCollection(WmiCollection[] vWmiCollectionArray)

Parameters:

vWmiCollectionArray -

setWmiCollection

public void setWmiCollection(List<WmiCollection> vWmiCollectionList)

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

Parameters:

vWmiCollectionList - the Vector to copy.

setWmiCollectionCollection

public void setWmiCollectionCollection(List<WmiCollection> wmiCollectionList)

Deprecated.

Sets the value of '_wmiCollectionList' by setting it to the given Vector. No type checking is performed.

Parameters:

wmiCollectionList - the Vector to set.

unmarshal

public static WmiDatacollectionConfig unmarshal(Reader reader)
                                         throws org.exolab.castor.xml.MarshalException,
                                                org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.wmi.WmiDatacollectionConfig

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema