org.opennms.netmgt.config.collectd
Class JmxDatacollectionConfig

java.lang.Object
  org.opennms.netmgt.config.collectd.JmxDatacollectionConfig

All Implemented Interfaces:

Serializable

public class JmxDatacollectionConfig
extends Object
implements Serializable

Class JmxDatacollectionConfig.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

JmxDatacollectionConfig()

Method Summary

void	addJmxCollection(int index, JmxCollection vJmxCollection)
void	addJmxCollection(JmxCollection vJmxCollection)
Enumeration<JmxCollection>	enumerateJmxCollection() Method enumerateJmxCollection.
JmxCollection[]	getJmxCollection() Method getJmxCollection.Returns the contents of the collection in an Array.
JmxCollection	getJmxCollection(int index) Method getJmxCollection.
List<JmxCollection>	getJmxCollectionCollection() Method getJmxCollectionCollection.Returns a reference to '_jmxCollectionList'.
int	getJmxCollectionCount() Method getJmxCollectionCount.
String	getRrdRepository() Returns the value of field 'rrdRepository'.
boolean	isValid() Method isValid.
Iterator<JmxCollection>	iterateJmxCollection() Method iterateJmxCollection.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllJmxCollection()
boolean	removeJmxCollection(JmxCollection vJmxCollection) Method removeJmxCollection.
JmxCollection	removeJmxCollectionAt(int index) Method removeJmxCollectionAt.
void	setJmxCollection(int index, JmxCollection vJmxCollection)
void	setJmxCollection(JmxCollection[] vJmxCollectionArray)
void	setJmxCollection(List<JmxCollection> vJmxCollectionList) Sets the value of '_jmxCollectionList' by copying the given Vector.
void	setJmxCollectionCollection(List<JmxCollection> jmxCollectionList) Deprecated.
void	setRrdRepository(String rrdRepository) Sets the value of field 'rrdRepository'.
static JmxDatacollectionConfig	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxDatacollectionConfig

public JmxDatacollectionConfig()

Method Detail

addJmxCollection

public void addJmxCollection(JmxCollection vJmxCollection)
                      throws IndexOutOfBoundsException

Parameters:

vJmxCollection -

Throws:

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

addJmxCollection

public void addJmxCollection(int index,
                             JmxCollection vJmxCollection)
                      throws IndexOutOfBoundsException

Parameters:

index -

vJmxCollection -

Throws:

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

enumerateJmxCollection

public Enumeration<JmxCollection> enumerateJmxCollection()

Method enumerateJmxCollection.

Returns:

an Enumeration over all possible elements of this collection

getJmxCollection

public JmxCollection getJmxCollection(int index)
                               throws IndexOutOfBoundsException

Method getJmxCollection.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.collectd.JmxCollection at the given index

Throws:

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

getJmxCollection

public JmxCollection[] getJmxCollection()

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

getJmxCollectionCollection

public List<JmxCollection> getJmxCollectionCollection()

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

Returns:

a reference to the Vector backing this class

getJmxCollectionCount

public int getJmxCollectionCount()

Method getJmxCollectionCount.

Returns:

the size of this collection

getRrdRepository

public String getRrdRepository()

Returns the value of field 'rrdRepository'.

Returns:

the value of field 'RrdRepository'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateJmxCollection

public Iterator<JmxCollection> iterateJmxCollection()

Method iterateJmxCollection.

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

removeAllJmxCollection

public void removeAllJmxCollection()

removeJmxCollection

public boolean removeJmxCollection(JmxCollection vJmxCollection)

Method removeJmxCollection.

Parameters:

vJmxCollection -

Returns:

true if the object was removed from the collection.

removeJmxCollectionAt

public JmxCollection removeJmxCollectionAt(int index)

Method removeJmxCollectionAt.

Parameters:

index -

Returns:

the element removed from the collection

setJmxCollection

public void setJmxCollection(int index,
                             JmxCollection vJmxCollection)
                      throws IndexOutOfBoundsException

Parameters:

index -

vJmxCollection -

Throws:

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

setJmxCollection

public void setJmxCollection(JmxCollection[] vJmxCollectionArray)

Parameters:

vJmxCollectionArray -

setJmxCollection

public void setJmxCollection(List<JmxCollection> vJmxCollectionList)

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

Parameters:

vJmxCollectionList - the Vector to copy.

setJmxCollectionCollection

public void setJmxCollectionCollection(List<JmxCollection> jmxCollectionList)

Deprecated.

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

Parameters:

jmxCollectionList - the Vector to set.

setRrdRepository

public void setRrdRepository(String rrdRepository)

Sets the value of field 'rrdRepository'.

Parameters:

rrdRepository - the value of field 'rrdRepository'.

unmarshal

public static JmxDatacollectionConfig 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.collectd.JmxDatacollectionConfig

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