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()

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 java.lang.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 java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Action>	iterateAction() Method iterateAction.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
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.
void	setActionCollection(List<Action> actionList) Deprecated.
static Actions	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Actions

public 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 java.lang.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 org.opennms.netmgt.config.vacuumd.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 java.lang.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.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateAction

public Iterator<Action> iterateAction()

Method iterateAction.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(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(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

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

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.

setActionCollection

public void setActionCollection(List<Action> actionList)

Deprecated.

Sets the value of '_actionList' by setting it to the given Vector. No type checking is performed.

Parameters:

actionList - the Vector to set.

unmarshal

public static Actions unmarshal(Reader reader)
                         throws org.exolab.castor.xml.MarshalException,
                                org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.vacuumd.Actions

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