org.opennms.netmgt.config.vacuumd

Class AutoEvents

java.lang.Object

org.opennms.netmgt.config.vacuumd.AutoEvents

All Implemented Interfaces:

Serializable

public class AutoEvents
extends Object
implements Serializable

Class AutoEvents.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AutoEvents()
AutoEvents(List<AutoEvent> autoEvents)

Method Summary

Modifier and Type	Method and Description
void	addAutoEvent(AutoEvent vAutoEvent)
void	addAutoEvent(int index, AutoEvent vAutoEvent)
Enumeration<AutoEvent>	enumerateAutoEvent() Method enumerateAutoEvent.
boolean	equals(Object obj) Overrides the Object.equals method.
AutoEvent[]	getAutoEvent() Method getAutoEvent.Returns the contents of the collection in an Array.
AutoEvent	getAutoEvent(int index) Method getAutoEvent.
List<AutoEvent>	getAutoEventCollection() Method getAutoEventCollection.Returns a reference to '_autoEventList'.
int	getAutoEventCount() Method getAutoEventCount.
int	hashCode() Overrides the Object.hashCode method.
Iterator<AutoEvent>	iterateAutoEvent() Method iterateAutoEvent.
void	removeAllAutoEvent()
boolean	removeAutoEvent(AutoEvent vAutoEvent) Method removeAutoEvent.
AutoEvent	removeAutoEventAt(int index) Method removeAutoEventAt.
void	setAutoEvent(AutoEvent[] vAutoEventArray)
void	setAutoEvent(int index, AutoEvent vAutoEvent)
void	setAutoEvent(List<AutoEvent> vAutoEventList) Sets the value of '_autoEventList' by copying the given Vector.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoEvents

public AutoEvents()

AutoEvents

public AutoEvents(List<AutoEvent> autoEvents)

Method Detail

addAutoEvent

public void addAutoEvent(AutoEvent vAutoEvent)
                  throws IndexOutOfBoundsException

Parameters:

vAutoEvent -

Throws:

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

addAutoEvent

public void addAutoEvent(int index,
                         AutoEvent vAutoEvent)
                  throws IndexOutOfBoundsException

Parameters:

index -

vAutoEvent -

Throws:

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

enumerateAutoEvent

public Enumeration<AutoEvent> enumerateAutoEvent()

Method enumerateAutoEvent.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getAutoEvent

public AutoEvent getAutoEvent(int index)
                       throws IndexOutOfBoundsException

Method getAutoEvent.

Parameters:

index -

Returns:

the value of the AutoEvent at the given inde

Throws:

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

getAutoEvent

public AutoEvent[] getAutoEvent()

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

getAutoEventCollection

public List<AutoEvent> getAutoEventCollection()

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

Returns:

a reference to the Vector backing this class

getAutoEventCount

public int getAutoEventCount()

Method getAutoEventCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Overrides the Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

iterateAutoEvent

public Iterator<AutoEvent> iterateAutoEvent()

Method iterateAutoEvent.

Returns:

an Iterator over all possible elements in this collection

removeAllAutoEvent

public void removeAllAutoEvent()

removeAutoEvent

public boolean removeAutoEvent(AutoEvent vAutoEvent)

Method removeAutoEvent.

Parameters:

vAutoEvent -

Returns:

true if the object was removed from the collection.

removeAutoEventAt

public AutoEvent removeAutoEventAt(int index)

Method removeAutoEventAt.

Parameters:

index -

Returns:

the element removed from the collection

setAutoEvent

public void setAutoEvent(int index,
                         AutoEvent vAutoEvent)
                  throws IndexOutOfBoundsException

Parameters:

index -

vAutoEvent -

Throws:

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

setAutoEvent

public void setAutoEvent(AutoEvent[] vAutoEventArray)

Parameters:

vAutoEventArray -

setAutoEvent

public void setAutoEvent(List<AutoEvent> vAutoEventList)

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

Parameters:

vAutoEventList - the Vector to copy.