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

Method Summary

Methods

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 java.lang.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 java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<ActionEvent>	iterateActionEvent() Method iterateActionEvent.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
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.
void	setActionEventCollection(List<ActionEvent> actionEventList) Deprecated.
static ActionEvents	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

ActionEvents

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

iterateActionEvent

public Iterator<ActionEvent> iterateActionEvent()

Method iterateActionEvent.

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

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.

setActionEventCollection

public void setActionEventCollection(List<ActionEvent> actionEventList)

Deprecated.

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

Parameters:

actionEventList - the Vector to set.

unmarshal

public static ActionEvents 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.ActionEvents

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