org.openoss.opennms.spring.qosd

Class Eventlist

java.lang.Object

org.openoss.opennms.spring.qosd.Eventlist

All Implemented Interfaces:

Serializable

public class Eventlist
extends Object
implements Serializable

Class Eventlist.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Eventlist()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUei(int index, String vUei)
void	addUei(String vUei)
Enumeration<String>	enumerateUei() Method enumerateUei.
String[]	getUei() Method getUei.Returns the contents of the collection in an Array.
String	getUei(int index) Method getUei.
List<String>	getUeiCollection() Method getUeiCollection.Returns a reference to '_ueiList'.
int	getUeiCount() Method getUeiCount.
boolean	isValid() Method isValid.
Iterator<String>	iterateUei() Method iterateUei.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllUei()
boolean	removeUei(String vUei) Method removeUei.
String	removeUeiAt(int index) Method removeUeiAt.
void	setUei(int index, String vUei)
void	setUei(List<String> vUeiList) Sets the value of '_ueiList' by copying the given Vector.
void	setUei(String[] vUeiArray)
void	setUeiCollection(List<String> ueiList) Deprecated.
static Eventlist	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

Eventlist

public Eventlist()

Method Detail

addUei

public void addUei(String vUei)
            throws IndexOutOfBoundsException

Parameters:

vUei -

Throws:

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

addUei

public void addUei(int index,
          String vUei)
            throws IndexOutOfBoundsException

Parameters:

index -

vUei -

Throws:

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

enumerateUei

public Enumeration<String> enumerateUei()

Method enumerateUei.

Returns:

an Enumeration over all possible elements of this collection

getUei

public String getUei(int index)
              throws IndexOutOfBoundsException

Method getUei.

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

getUei

public String[] getUei()

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

getUeiCollection

public List<String> getUeiCollection()

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

Returns:

a reference to the Vector backing this class

getUeiCount

public int getUeiCount()

Method getUeiCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateUei

public Iterator<String> iterateUei()

Method iterateUei.

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

removeAllUei

public void removeAllUei()

removeUei

public boolean removeUei(String vUei)

Method removeUei.

Parameters:

vUei -

Returns:

true if the object was removed from the collection.

removeUeiAt

public String removeUeiAt(int index)

Method removeUeiAt.

Parameters:

index -

Returns:

the element removed from the collection

setUei

public void setUei(int index,
          String vUei)
            throws IndexOutOfBoundsException

Parameters:

index -

vUei -

Throws:

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

setUei

public void setUei(String[] vUeiArray)

Parameters:

vUeiArray -

setUei

public void setUei(List<String> vUeiList)

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

Parameters:

vUeiList - the Vector to copy.

setUeiCollection

public void setUeiCollection(List<String> ueiList)

Deprecated.

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

Parameters:

ueiList - the Vector to set.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.openoss.opennms.spring.qosd.Eventlist

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