org.openoss.opennms.spring.qosd
Class Eventlist

java.lang.Object
  extended by org.openoss.opennms.spring.qosd.Eventlist
All Implemented Interfaces:
java.io.Serializable

public class Eventlist
extends java.lang.Object
implements java.io.Serializable

Class Eventlist.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Eventlist()
           
 
Method Summary
 void addUei(int index, java.lang.String vUei)
           
 void addUei(java.lang.String vUei)
           
 java.util.Enumeration<java.lang.String> enumerateUei()
          Method enumerateUei.
 java.lang.String[] getUei()
          Method getUei.Returns the contents of the collection in an Array.
 java.lang.String getUei(int index)
          Method getUei.
 java.util.List<java.lang.String> getUeiCollection()
          Method getUeiCollection.Returns a reference to '_ueiList'.
 int getUeiCount()
          Method getUeiCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<java.lang.String> iterateUei()
          Method iterateUei.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllUei()
           
 boolean removeUei(java.lang.String vUei)
          Method removeUei.
 java.lang.String removeUeiAt(int index)
          Method removeUeiAt.
 void setUei(int index, java.lang.String vUei)
           
 void setUei(java.util.List<java.lang.String> vUeiList)
          Sets the value of '_ueiList' by copying the given Vector.
 void setUei(java.lang.String[] vUeiArray)
           
 void setUeiCollection(java.util.List<java.lang.String> ueiList)
          Deprecated.  
static Eventlist unmarshal(java.io.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(java.lang.String vUei)
            throws java.lang.IndexOutOfBoundsException
Parameters:
vUei -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addUei

public void addUei(int index,
                   java.lang.String vUei)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vUei -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateUei

public java.util.Enumeration<java.lang.String> enumerateUei()
Method enumerateUei.

Returns:
an Enumeration over all possible elements of this collection

getUei

public java.lang.String getUei(int index)
                        throws java.lang.IndexOutOfBoundsException
Method getUei.

Parameters:
index -
Returns:
the value of the java.lang.String at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getUei

public java.lang.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 java.util.List<java.lang.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 java.util.Iterator<java.lang.String> iterateUei()
Method iterateUei.

Returns:
an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.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(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
Throws:
java.io.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(java.lang.String vUei)
Method removeUei.

Parameters:
vUei -
Returns:
true if the object was removed from the collection.

removeUeiAt

public java.lang.String removeUeiAt(int index)
Method removeUeiAt.

Parameters:
index -
Returns:
the element removed from the collection

setUei

public void setUei(int index,
                   java.lang.String vUei)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vUei -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setUei

public void setUei(java.lang.String[] vUeiArray)
Parameters:
vUeiArray -

setUei

public void setUei(java.util.List<java.lang.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(java.util.List<java.lang.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(java.io.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


Copyright ? 2006-2008. All Rights Reserved.