org.opennms.netmgt.config.nsclient

Class NsclientDatacollectionConfig

java.lang.Object

org.opennms.netmgt.config.nsclient.NsclientDatacollectionConfig

All Implemented Interfaces:

Serializable

public class NsclientDatacollectionConfig
extends Object
implements Serializable

Class NsclientDatacollectionConfig.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NsclientDatacollectionConfig()

Method Summary

Modifier and Type	Method and Description
void	addNsclientCollection(int index, NsclientCollection vNsclientCollection)
void	addNsclientCollection(NsclientCollection vNsclientCollection)
Enumeration<NsclientCollection>	enumerateNsclientCollection() Method enumerateNsclientCollection.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
NsclientCollection[]	getNsclientCollection() Method getNsclientCollection.Returns the contents of the collection in an Array.
NsclientCollection	getNsclientCollection(int index) Method getNsclientCollection.
List<NsclientCollection>	getNsclientCollectionCollection() Method getNsclientCollectionCollection.Returns a reference to '_nsclientCollectionList'.
int	getNsclientCollectionCount() Method getNsclientCollectionCount.
String	getRrdRepository() Returns the value of field 'rrdRepository'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<NsclientCollection>	iterateNsclientCollection() Method iterateNsclientCollection.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllNsclientCollection()
boolean	removeNsclientCollection(NsclientCollection vNsclientCollection) Method removeNsclientCollection.
NsclientCollection	removeNsclientCollectionAt(int index) Method removeNsclientCollectionAt.
void	setNsclientCollection(int index, NsclientCollection vNsclientCollection)
void	setNsclientCollection(List<NsclientCollection> vNsclientCollectionList) Sets the value of '_nsclientCollectionList' by copying the given Vector.
void	setNsclientCollection(NsclientCollection[] vNsclientCollectionArray)
void	setNsclientCollectionCollection(List<NsclientCollection> nsclientCollectionList) Deprecated.
void	setRrdRepository(String rrdRepository) Sets the value of field 'rrdRepository'.
static NsclientDatacollectionConfig	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

NsclientDatacollectionConfig

public NsclientDatacollectionConfig()

Method Detail

addNsclientCollection

public void addNsclientCollection(NsclientCollection vNsclientCollection)
                           throws IndexOutOfBoundsException

Parameters:

vNsclientCollection -

Throws:

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

addNsclientCollection

public void addNsclientCollection(int index,
                                  NsclientCollection vNsclientCollection)
                           throws IndexOutOfBoundsException

Parameters:

index -

vNsclientCollection -

Throws:

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

enumerateNsclientCollection

public Enumeration<NsclientCollection> enumerateNsclientCollection()

Method enumerateNsclientCollection.

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.

getNsclientCollection

public NsclientCollection getNsclientCollection(int index)
                                         throws IndexOutOfBoundsException

Method getNsclientCollection.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.nsclient.NsclientCollection at the given index

Throws:

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

getNsclientCollection

public NsclientCollection[] getNsclientCollection()

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

getNsclientCollectionCollection

public List<NsclientCollection> getNsclientCollectionCollection()

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

Returns:

a reference to the Vector backing this class

getNsclientCollectionCount

public int getNsclientCollectionCount()

Method getNsclientCollectionCount.

Returns:

the size of this collection

getRrdRepository

public String getRrdRepository()

Returns the value of field 'rrdRepository'.

Returns:

the value of field 'RrdRepository'.

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

iterateNsclientCollection

public Iterator<NsclientCollection> iterateNsclientCollection()

Method iterateNsclientCollection.

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

removeAllNsclientCollection

public void removeAllNsclientCollection()

removeNsclientCollection

public boolean removeNsclientCollection(NsclientCollection vNsclientCollection)

Method removeNsclientCollection.

Parameters:

vNsclientCollection -

Returns:

true if the object was removed from the collection.

removeNsclientCollectionAt

public NsclientCollection removeNsclientCollectionAt(int index)

Method removeNsclientCollectionAt.

Parameters:

index -

Returns:

the element removed from the collection

setNsclientCollection

public void setNsclientCollection(int index,
                                  NsclientCollection vNsclientCollection)
                           throws IndexOutOfBoundsException

Parameters:

index -

vNsclientCollection -

Throws:

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

setNsclientCollection

public void setNsclientCollection(NsclientCollection[] vNsclientCollectionArray)

Parameters:

vNsclientCollectionArray -

setNsclientCollection

public void setNsclientCollection(List<NsclientCollection> vNsclientCollectionList)

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

Parameters:

vNsclientCollectionList - the Vector to copy.

setNsclientCollectionCollection

public void setNsclientCollectionCollection(List<NsclientCollection> nsclientCollectionList)

Deprecated.

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

Parameters:

nsclientCollectionList - 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 NsclientDatacollectionConfig 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.nsclient.NsclientDatacollectionConfig

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