org.opennms.netmgt.xml.event
Class EventReceipt

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

All Implemented Interfaces:

Serializable

public class EventReceipt
extends Object
implements Serializable

Class EventReceipt.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

EventReceipt()

Method Summary

void	addUuid(int index, String vUuid)
void	addUuid(String vUuid)
Enumeration<String>	enumerateUuid() Method enumerateUuid.
String[]	getUuid() Method getUuid.Returns the contents of the collection in an Array.
String	getUuid(int index) Method getUuid.
List<String>	getUuidCollection() Method getUuidCollection.Returns a reference to '_uuidList'.
int	getUuidCount() Method getUuidCount.
boolean	isValid() Method isValid.
Iterator<String>	iterateUuid() Method iterateUuid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllUuid()
boolean	removeUuid(String vUuid) Method removeUuid.
String	removeUuidAt(int index) Method removeUuidAt.
void	setUuid(int index, String vUuid)
void	setUuid(List<String> vUuidList) Sets the value of '_uuidList' by copying the given Vector.
void	setUuid(String[] vUuidArray)
void	setUuidCollection(List<String> uuidList) Deprecated.
static EventReceipt	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

EventReceipt

public EventReceipt()

Method Detail

addUuid

public void addUuid(String vUuid)
             throws IndexOutOfBoundsException

Parameters:

vUuid -

Throws:

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

addUuid

public void addUuid(int index,
                    String vUuid)
             throws IndexOutOfBoundsException

Parameters:

index -

vUuid -

Throws:

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

enumerateUuid

public Enumeration<String> enumerateUuid()

Method enumerateUuid.

Returns:

an Enumeration over all possible elements of this collection

getUuid

public String getUuid(int index)
               throws IndexOutOfBoundsException

Method getUuid.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

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

getUuid

public String[] getUuid()

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

getUuidCollection

public List<String> getUuidCollection()

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

Returns:

a reference to the Vector backing this class

getUuidCount

public int getUuidCount()

Method getUuidCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateUuid

public Iterator<String> iterateUuid()

Method iterateUuid.

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

removeAllUuid

public void removeAllUuid()

removeUuid

public boolean removeUuid(String vUuid)

Method removeUuid.

Parameters:

vUuid -

Returns:

true if the object was removed from the collection.

removeUuidAt

public String removeUuidAt(int index)

Method removeUuidAt.

Parameters:

index -

Returns:

the element removed from the collection

setUuid

public void setUuid(int index,
                    String vUuid)
             throws IndexOutOfBoundsException

Parameters:

index -

vUuid -

Throws:

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

setUuid

public void setUuid(String[] vUuidArray)

Parameters:

vUuidArray -

setUuid

public void setUuid(List<String> vUuidList)

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

Parameters:

vUuidList - the Vector to copy.

setUuidCollection

public void setUuidCollection(List<String> uuidList)

Deprecated.

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

Parameters:

uuidList - the Vector to set.

unmarshal

public static EventReceipt 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.EventReceipt

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