org.opennms.netmgt.config.xmpDataCollection

Class XmpDatacollectionConfig

java.lang.Object

org.opennms.netmgt.config.xmpDataCollection.XmpDatacollectionConfig

All Implemented Interfaces:

Serializable

public class XmpDatacollectionConfig
extends Object
implements Serializable

Top-level element for the xmp-datacollection-config.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmpDatacollectionConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	addXmpCollection(int index, XmpCollection vXmpCollection)
void	addXmpCollection(XmpCollection vXmpCollection)
Enumeration<XmpCollection>	enumerateXmpCollection() Method enumerateXmpCollection.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getRrdRepository() Returns the value of field 'rrdRepository'.
XmpCollection[]	getXmpCollection() Method getXmpCollection.Returns the contents of the collection in an Array.
XmpCollection	getXmpCollection(int index) Method getXmpCollection.
List<XmpCollection>	getXmpCollectionCollection() Method getXmpCollectionCollection.Returns a reference to '_xmpCollectionList'.
int	getXmpCollectionCount() Method getXmpCollectionCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<XmpCollection>	iterateXmpCollection() Method iterateXmpCollection.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllXmpCollection()
boolean	removeXmpCollection(XmpCollection vXmpCollection) Method removeXmpCollection.
XmpCollection	removeXmpCollectionAt(int index) Method removeXmpCollectionAt.
void	setRrdRepository(String rrdRepository) Sets the value of field 'rrdRepository'.
void	setXmpCollection(int index, XmpCollection vXmpCollection)
void	setXmpCollection(List<XmpCollection> vXmpCollectionList) Sets the value of '_xmpCollectionList' by copying the given Vector.
void	setXmpCollection(XmpCollection[] vXmpCollectionArray)
void	setXmpCollectionCollection(List<XmpCollection> xmpCollectionList) Deprecated.
static XmpDatacollectionConfig	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

XmpDatacollectionConfig

public XmpDatacollectionConfig()

Method Detail

addXmpCollection

public void addXmpCollection(XmpCollection vXmpCollection)
                      throws IndexOutOfBoundsException

Parameters:

vXmpCollection -

Throws:

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

addXmpCollection

public void addXmpCollection(int index,
                    XmpCollection vXmpCollection)
                      throws IndexOutOfBoundsException

Parameters:

index -

vXmpCollection -

Throws:

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

enumerateXmpCollection

public Enumeration<XmpCollection> enumerateXmpCollection()

Method enumerateXmpCollection.

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'. The field 'rrdRepository' has the following description: full path to the RRD repository for collected XMP data

Returns:

the value of field 'RrdRepository'.

getXmpCollection

public XmpCollection getXmpCollection(int index)
                               throws IndexOutOfBoundsException

Method getXmpCollection.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.xmpDataCollection.XmpCollection at the given index

Throws:

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

getXmpCollection

public XmpCollection[] getXmpCollection()

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

getXmpCollectionCollection

public List<XmpCollection> getXmpCollectionCollection()

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

Returns:

a reference to the Vector backing this class

getXmpCollectionCount

public int getXmpCollectionCount()

Method getXmpCollectionCount.

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

iterateXmpCollection

public Iterator<XmpCollection> iterateXmpCollection()

Method iterateXmpCollection.

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

removeAllXmpCollection

public void removeAllXmpCollection()

removeXmpCollection

public boolean removeXmpCollection(XmpCollection vXmpCollection)

Method removeXmpCollection.

Parameters:

vXmpCollection -

Returns:

true if the object was removed from the collection.

removeXmpCollectionAt

public XmpCollection removeXmpCollectionAt(int index)

Method removeXmpCollectionAt.

Parameters:

index -

Returns:

the element removed from the collection

setRrdRepository

public void setRrdRepository(String rrdRepository)

Sets the value of field 'rrdRepository'. The field 'rrdRepository' has the following description: full path to the RRD repository for collected XMP data

Parameters:

rrdRepository - the value of field 'rrdRepository'.

setXmpCollection

public void setXmpCollection(int index,
                    XmpCollection vXmpCollection)
                      throws IndexOutOfBoundsException

Parameters:

index -

vXmpCollection -

Throws:

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

setXmpCollection

public void setXmpCollection(XmpCollection[] vXmpCollectionArray)

Parameters:

vXmpCollectionArray -

setXmpCollection

public void setXmpCollection(List<XmpCollection> vXmpCollectionList)

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

Parameters:

vXmpCollectionList - the Vector to copy.

setXmpCollectionCollection

public void setXmpCollectionCollection(List<XmpCollection> xmpCollectionList)

Deprecated.

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

Parameters:

xmpCollectionList - the Vector to set.

unmarshal

public static XmpDatacollectionConfig 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.xmpDataCollection.XmpDatacollectionConfig

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