org.opennms.netmgt.config.vacuumd

Class Actions

java.lang.Object

org.opennms.netmgt.config.vacuumd.Actions

All Implemented Interfaces:

Serializable

public class Actions
extends Object
implements Serializable

A collection of actions

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Actions()
Actions(List<Action> actions)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAction(Action vAction)
void	addAction(int index, Action vAction)
Enumeration<Action>	enumerateAction() Method enumerateAction.
boolean	equals(Object obj) Overrides the Object.equals method.
Action[]	getAction() Method getAction.Returns the contents of the collection in an Array.
Action	getAction(int index) Method getAction.
List<Action>	getActionCollection() Method getActionCollection.Returns a reference to '_actionList'.
int	getActionCount() Method getActionCount.
int	hashCode() Overrides the Object.hashCode method.
Iterator<Action>	iterateAction() Method iterateAction.
boolean	removeAction(Action vAction) Method removeAction.
Action	removeActionAt(int index) Method removeActionAt.
void	removeAllAction()
void	setAction(Action[] vActionArray)
void	setAction(int index, Action vAction)
void	setAction(List<Action> vActionList) Sets the value of '_actionList' by copying the given Vector.

Methods inherited from class java.lang.Object

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

Constructor Detail

Actions

public Actions()

Actions

public Actions(List<Action> actions)

Method Detail

addAction

public void addAction(Action vAction)
               throws IndexOutOfBoundsException

Parameters:

vAction -

Throws:

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

addAction

public void addAction(int index,
             Action vAction)
               throws IndexOutOfBoundsException

Parameters:

index -

vAction -

Throws:

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

enumerateAction

public Enumeration<Action> enumerateAction()

Method enumerateAction.

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.

getAction

public Action getAction(int index)
                 throws IndexOutOfBoundsException

Method getAction.

Parameters:

index -

Returns:

the value of the Action at the given index

Throws:

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

getAction

public Action[] getAction()

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

getActionCollection

public List<Action> getActionCollection()

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

Returns:

a reference to the Vector backing this class

getActionCount

public int getActionCount()

Method getActionCount.

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.

iterateAction

public Iterator<Action> iterateAction()

Method iterateAction.

Returns:

an Iterator over all possible elements in this collection

removeAction

public boolean removeAction(Action vAction)

Method removeAction.

Parameters:

vAction -

Returns:

true if the object was removed from the collection.

removeActionAt

public Action removeActionAt(int index)

Method removeActionAt.

Parameters:

index -

Returns:

the element removed from the collection

removeAllAction

public void removeAllAction()

setAction

public void setAction(int index,
             Action vAction)
               throws IndexOutOfBoundsException

Parameters:

index -

vAction -

Throws:

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

setAction

public void setAction(Action[] vActionArray)

Parameters:

vActionArray -

setAction

public void setAction(List<Action> vActionList)

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

Parameters:

vActionList - the Vector to copy.