org.opennms.netmgt.config.datacollection
Class Systems

java.lang.Object
  org.opennms.netmgt.config.datacollection.Systems

All Implemented Interfaces:

Serializable

public class Systems
extends Object
implements Serializable

systems

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Systems()

Method Summary

void	addSystemDef(int index, SystemDef vSystemDef)
void	addSystemDef(SystemDef vSystemDef)
Enumeration<SystemDef>	enumerateSystemDef() Method enumerateSystemDef.
SystemDef[]	getSystemDef() Method getSystemDef.Returns the contents of the collection in an Array.
SystemDef	getSystemDef(int index) Method getSystemDef.
List<SystemDef>	getSystemDefCollection() Method getSystemDefCollection.Returns a reference to '_systemDefList'.
int	getSystemDefCount() Method getSystemDefCount.
boolean	isValid() Method isValid.
Iterator<SystemDef>	iterateSystemDef() Method iterateSystemDef.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllSystemDef()
boolean	removeSystemDef(SystemDef vSystemDef) Method removeSystemDef.
SystemDef	removeSystemDefAt(int index) Method removeSystemDefAt.
void	setSystemDef(int index, SystemDef vSystemDef)
void	setSystemDef(List<SystemDef> vSystemDefList) Sets the value of '_systemDefList' by copying the given Vector.
void	setSystemDef(SystemDef[] vSystemDefArray)
void	setSystemDefCollection(List<SystemDef> systemDefList) Deprecated.
static Systems	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

Systems

public Systems()

Method Detail

addSystemDef

public void addSystemDef(SystemDef vSystemDef)
                  throws IndexOutOfBoundsException

Parameters:

vSystemDef -

Throws:

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

addSystemDef

public void addSystemDef(int index,
                         SystemDef vSystemDef)
                  throws IndexOutOfBoundsException

Parameters:

index -

vSystemDef -

Throws:

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

enumerateSystemDef

public Enumeration<SystemDef> enumerateSystemDef()

Method enumerateSystemDef.

Returns:

an Enumeration over all possible elements of this collection

getSystemDef

public SystemDef getSystemDef(int index)
                       throws IndexOutOfBoundsException

Method getSystemDef.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.datacollection.SystemDef at the given index

Throws:

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

getSystemDef

public SystemDef[] getSystemDef()

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

getSystemDefCollection

public List<SystemDef> getSystemDefCollection()

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

Returns:

a reference to the Vector backing this class

getSystemDefCount

public int getSystemDefCount()

Method getSystemDefCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateSystemDef

public Iterator<SystemDef> iterateSystemDef()

Method iterateSystemDef.

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

removeAllSystemDef

public void removeAllSystemDef()

removeSystemDef

public boolean removeSystemDef(SystemDef vSystemDef)

Method removeSystemDef.

Parameters:

vSystemDef -

Returns:

true if the object was removed from the collection.

removeSystemDefAt

public SystemDef removeSystemDefAt(int index)

Method removeSystemDefAt.

Parameters:

index -

Returns:

the element removed from the collection

setSystemDef

public void setSystemDef(int index,
                         SystemDef vSystemDef)
                  throws IndexOutOfBoundsException

Parameters:

index -

vSystemDef -

Throws:

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

setSystemDef

public void setSystemDef(SystemDef[] vSystemDefArray)

Parameters:

vSystemDefArray -

setSystemDef

public void setSystemDef(List<SystemDef> vSystemDefList)

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

Parameters:

vSystemDefList - the Vector to copy.

setSystemDefCollection

public void setSystemDefCollection(List<SystemDef> systemDefList)

Deprecated.

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

Parameters:

systemDefList - the Vector to set.

unmarshal

public static Systems 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.datacollection.Systems

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