Package org.opennms.netmgt.xml.event

Class Events

  • All Implemented Interfaces:
    java.io.Serializable
    public class Events
extends java.lang.Object
implements java.io.Serializable
    Class Events.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Detail

      • Events

        public Events()

    • Method Detail

      • addEvent

        public void addEvent​(Event vEvent)
              throws java.lang.IndexOutOfBoundsException
        Parameters:
        vEvent -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addEvent

        public void addEvent​(int index,
                     Event vEvent)
              throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vEvent -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • enumerateEvent

        public java.util.Enumeration<Event> enumerateEvent()
        Method enumerateEvent.
        Returns:
        an Enumeration over all possible elements of this collection

      • getEvent

        public Event getEvent​(int index)
               throws java.lang.IndexOutOfBoundsException
        Method getEvent.
        Parameters:
        index -
        Returns:
        the value of the org.opennms.netmgt.xml.event.Event at the given index
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • getEvent

        public Event[] getEvent()
        Method getEvent.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

      • getEventCollection

        public java.util.List<Event> getEventCollection()
        Method getEventCollection.Returns a reference to '_eventList'. No type checking is performed on any modifications to the Vector.
        Returns:
        a reference to the Vector backing this class

      • getEventCount

        public int getEventCount()
        Method getEventCount.
        Returns:
        the size of this collection

      • iterateEvent

        public java.util.Iterator<Event> iterateEvent()
        Method iterateEvent.
        Returns:
        an Iterator over all possible elements in this collection

      • removeAllEvent

        public void removeAllEvent()

      • removeEvent

        public boolean removeEvent​(Event vEvent)
        Method removeEvent.
        Parameters:
        vEvent -
        Returns:
        true if the object was removed from the collection.

      • removeEventAt

        public Event removeEventAt​(int index)
        Method removeEventAt.
        Parameters:
        index -
        Returns:
        the element removed from the collection

      • setEvent

        public void setEvent​(int index,
                     Event vEvent)
              throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vEvent -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • setEvent

        public void setEvent​(Event[] vEventArray)
        Parameters:
        vEventArray -

      • setEvent

        public void setEvent​(java.util.List<Event> vEventList)
        Sets the value of '_eventList' by copying the given Vector. All elements will be checked for type safety.
        Parameters:
        vEventList - the Vector to copy.

      • setEventCollection

        public void setEventCollection​(java.util.List<Event> eventList)
        Deprecated.
        Sets the value of '_eventList' by setting it to the given Vector. No type checking is performed.
        Parameters:
        eventList - the Vector to set.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • addAllEvents

        public void addAllEvents​(Events events)