org.opennms.netmgt.config.vacuumd

Class ActionEvents

java.lang.Object

org.opennms.netmgt.config.vacuumd.ActionEvents

All Implemented Interfaces:

Serializable

public class ActionEvents
extends Object
implements Serializable

Class ActionEvents.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionEvents()
ActionEvents(List<ActionEvent> actionEvents)

Method Summary

Modifier and Type	Method and Description
void	addActionEvent(ActionEvent vActionEvent)
void	addActionEvent(int index, ActionEvent vActionEvent)
Enumeration<ActionEvent>	enumerateActionEvent() Method enumerateActionEvent.
boolean	equals(Object obj) Overrides the Object.equals method.
ActionEvent[]	getActionEvent() Method getActionEvent.Returns the contents of the collection in an Array.
ActionEvent	getActionEvent(int index) Method getActionEvent.
List<ActionEvent>	getActionEventCollection() Method getActionEventCollection.Returns a reference to '_actionEventList'.
int	getActionEventCount() Method getActionEventCount.
int	hashCode() Overrides the Object.hashCode method.
Iterator<ActionEvent>	iterateActionEvent() Method iterateActionEvent.
boolean	removeActionEvent(ActionEvent vActionEvent) Method removeActionEvent.
ActionEvent	removeActionEventAt(int index) Method removeActionEventAt.
void	removeAllActionEvent()
void	setActionEvent(ActionEvent[] vActionEventArray)
void	setActionEvent(int index, ActionEvent vActionEvent)
void	setActionEvent(List<ActionEvent> vActionEventList) Sets the value of '_actionEventList' by copying the given Vector.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionEvents

public ActionEvents()

ActionEvents

public ActionEvents(List<ActionEvent> actionEvents)

Method Detail

addActionEvent

public void addActionEvent(ActionEvent vActionEvent)
                    throws IndexOutOfBoundsException

Parameters:

vActionEvent -

Throws:

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

addActionEvent

public void addActionEvent(int index,
                           ActionEvent vActionEvent)
                    throws IndexOutOfBoundsException

Parameters:

index -

vActionEvent -

Throws:

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

enumerateActionEvent

public Enumeration<ActionEvent> enumerateActionEvent()

Method enumerateActionEvent.

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.

getActionEvent

public ActionEvent getActionEvent(int index)
                           throws IndexOutOfBoundsException

Method getActionEvent.

Parameters:

index -

Returns:

the value of the ActionEvent at the given index

Throws:

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

getActionEvent

public ActionEvent[] getActionEvent()

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

getActionEventCollection

public List<ActionEvent> getActionEventCollection()

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

Returns:

a reference to the Vector backing this class

getActionEventCount

public int getActionEventCount()

Method getActionEventCount.

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.

iterateActionEvent

public Iterator<ActionEvent> iterateActionEvent()

Method iterateActionEvent.

Returns:

an Iterator over all possible elements in this collection

removeActionEvent

public boolean removeActionEvent(ActionEvent vActionEvent)

Method removeActionEvent.

Parameters:

vActionEvent -

Returns:

true if the object was removed from the collection.

removeActionEventAt

public ActionEvent removeActionEventAt(int index)

Method removeActionEventAt.

Parameters:

index -

Returns:

the element removed from the collection

removeAllActionEvent

public void removeAllActionEvent()

setActionEvent

public void setActionEvent(int index,
                           ActionEvent vActionEvent)
                    throws IndexOutOfBoundsException

Parameters:

index -

vActionEvent -

Throws:

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

setActionEvent

public void setActionEvent(ActionEvent[] vActionEventArray)

Parameters:

vActionEventArray -

setActionEvent

public void setActionEvent(List<ActionEvent> vActionEventList)

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

Parameters:

vActionEventList - the Vector to copy.