org.opennms.netmgt.xml.event
Class Parms

java.lang.Object
  org.opennms.netmgt.xml.event.Parms

All Implemented Interfaces:

Serializable

public class Parms
extends Object
implements Serializable

The varbinds from the trap

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Parms()

Method Summary

void	addParm(int index, Parm vParm)
void	addParm(Parm vParm)
Enumeration<Parm>	enumerateParm() Method enumerateParm.
Parm[]	getParm() Method getParm.Returns the contents of the collection in an Array.
Parm	getParm(int index) Method getParm.
List<Parm>	getParmCollection() Method getParmCollection.Returns a reference to '_parmList'.
int	getParmCount() Method getParmCount.
boolean	isValid() Method isValid.
Iterator<Parm>	iterateParm() Method iterateParm.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllParm()
boolean	removeParm(Parm vParm) Method removeParm.
Parm	removeParmAt(int index) Method removeParmAt.
void	setParm(int index, Parm vParm)
void	setParm(List<Parm> vParmList) Sets the value of '_parmList' by copying the given Vector.
void	setParm(Parm[] vParmArray)
void	setParmCollection(List<Parm> parmList) Deprecated.
static Parms	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

Parms

public Parms()

Method Detail

addParm

public void addParm(Parm vParm)
             throws IndexOutOfBoundsException

Parameters:

vParm -

Throws:

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

addParm

public void addParm(int index,
                    Parm vParm)
             throws IndexOutOfBoundsException

Parameters:

index -

vParm -

Throws:

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

enumerateParm

public Enumeration<Parm> enumerateParm()

Method enumerateParm.

Returns:

an Enumeration over all possible elements of this collection

getParm

public Parm getParm(int index)
             throws IndexOutOfBoundsException

Method getParm.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.xml.event.Parm at the given index

Throws:

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

getParm

public Parm[] getParm()

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

getParmCollection

public List<Parm> getParmCollection()

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

Returns:

a reference to the Vector backing this class

getParmCount

public int getParmCount()

Method getParmCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateParm

public Iterator<Parm> iterateParm()

Method iterateParm.

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

removeAllParm

public void removeAllParm()

removeParm

public boolean removeParm(Parm vParm)

Method removeParm.

Parameters:

vParm -

Returns:

true if the object was removed from the collection.

removeParmAt

public Parm removeParmAt(int index)

Method removeParmAt.

Parameters:

index -

Returns:

the element removed from the collection

setParm

public void setParm(int index,
                    Parm vParm)
             throws IndexOutOfBoundsException

Parameters:

index -

vParm -

Throws:

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

setParm

public void setParm(Parm[] vParmArray)

Parameters:

vParmArray -

setParm

public void setParm(List<Parm> vParmList)

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

Parameters:

vParmList - the Vector to copy.

setParmCollection

public void setParmCollection(List<Parm> parmList)

Deprecated.

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

Parameters:

parmList - the Vector to set.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.xml.event.Parms

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