org.opennms.netmgt.config.vacuumd
Class ActionEvent

java.lang.Object
  org.opennms.netmgt.config.vacuumd.ActionEvent

All Implemented Interfaces:

Serializable

public class ActionEvent
extends Object
implements Serializable

Class ActionEvent.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ActionEvent()

Method Summary

void	addAssignment(Assignment vAssignment)
void	addAssignment(int index, Assignment vAssignment)
void	deleteAddAllParms()
void	deleteForEachResult()
Enumeration<Assignment>	enumerateAssignment() Method enumerateAssignment.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
boolean	getAddAllParms() Returns the value of field 'addAllParms'.
Assignment[]	getAssignment() Method getAssignment.Returns the contents of the collection in an Array.
Assignment	getAssignment(int index) Method getAssignment.
List<Assignment>	getAssignmentCollection() Method getAssignmentCollection.Returns a reference to '_assignmentList'.
int	getAssignmentCount() Method getAssignmentCount.
boolean	getForEachResult() Returns the value of field 'forEachResult'.
String	getName() Returns the value of field 'name'.
boolean	hasAddAllParms() Method hasAddAllParms.
boolean	hasForEachResult() Method hasForEachResult.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isAddAllParms() Returns the value of field 'addAllParms'.
boolean	isForEachResult() Returns the value of field 'forEachResult'.
boolean	isValid() Method isValid.
Iterator<Assignment>	iterateAssignment() Method iterateAssignment.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllAssignment()
boolean	removeAssignment(Assignment vAssignment) Method removeAssignment.
Assignment	removeAssignmentAt(int index) Method removeAssignmentAt.
void	setAddAllParms(boolean addAllParms) Sets the value of field 'addAllParms'.
void	setAssignment(Assignment[] vAssignmentArray)
void	setAssignment(int index, Assignment vAssignment)
void	setAssignment(List<Assignment> vAssignmentList) Sets the value of '_assignmentList' by copying the given Vector.
void	setAssignmentCollection(List<Assignment> assignmentList) Deprecated.
void	setForEachResult(boolean forEachResult) Sets the value of field 'forEachResult'.
void	setName(String name) Sets the value of field 'name'.
static ActionEvent	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

ActionEvent

public ActionEvent()

Method Detail

addAssignment

public void addAssignment(Assignment vAssignment)
                   throws IndexOutOfBoundsException

Parameters:

vAssignment -

Throws:

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

addAssignment

public void addAssignment(int index,
                          Assignment vAssignment)
                   throws IndexOutOfBoundsException

Parameters:

index -

vAssignment -

Throws:

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

deleteAddAllParms

public void deleteAddAllParms()

deleteForEachResult

public void deleteForEachResult()

enumerateAssignment

public Enumeration<Assignment> enumerateAssignment()

Method enumerateAssignment.

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.

getAddAllParms

public boolean getAddAllParms()

Returns the value of field 'addAllParms'.

Returns:

the value of field 'AddAllParms'.

getAssignment

public Assignment getAssignment(int index)
                         throws IndexOutOfBoundsException

Method getAssignment.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.vacuumd.Assignment at the given index

Throws:

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

getAssignment

public Assignment[] getAssignment()

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

getAssignmentCollection

public List<Assignment> getAssignmentCollection()

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

Returns:

a reference to the Vector backing this class

getAssignmentCount

public int getAssignmentCount()

Method getAssignmentCount.

Returns:

the size of this collection

getForEachResult

public boolean getForEachResult()

Returns the value of field 'forEachResult'.

Returns:

the value of field 'ForEachResult'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

hasAddAllParms

public boolean hasAddAllParms()

Method hasAddAllParms.

Returns:

true if at least one AddAllParms has been added

hasForEachResult

public boolean hasForEachResult()

Method hasForEachResult.

Returns:

true if at least one ForEachResult has been added

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.

isAddAllParms

public boolean isAddAllParms()

Returns the value of field 'addAllParms'.

Returns:

the value of field 'AddAllParms'.

isForEachResult

public boolean isForEachResult()

Returns the value of field 'forEachResult'.

Returns:

the value of field 'ForEachResult'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateAssignment

public Iterator<Assignment> iterateAssignment()

Method iterateAssignment.

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

removeAllAssignment

public void removeAllAssignment()

removeAssignment

public boolean removeAssignment(Assignment vAssignment)

Method removeAssignment.

Parameters:

vAssignment -

Returns:

true if the object was removed from the collection.

removeAssignmentAt

public Assignment removeAssignmentAt(int index)

Method removeAssignmentAt.

Parameters:

index -

Returns:

the element removed from the collection

setAddAllParms

public void setAddAllParms(boolean addAllParms)

Sets the value of field 'addAllParms'.

Parameters:

addAllParms - the value of field 'addAllParms'.

setAssignment

public void setAssignment(int index,
                          Assignment vAssignment)
                   throws IndexOutOfBoundsException

Parameters:

index -

vAssignment -

Throws:

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

setAssignment

public void setAssignment(Assignment[] vAssignmentArray)

Parameters:

vAssignmentArray -

setAssignment

public void setAssignment(List<Assignment> vAssignmentList)

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

Parameters:

vAssignmentList - the Vector to copy.

setAssignmentCollection

public void setAssignmentCollection(List<Assignment> assignmentList)

Deprecated.

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

Parameters:

assignmentList - the Vector to set.

setForEachResult

public void setForEachResult(boolean forEachResult)

Sets the value of field 'forEachResult'.

Parameters:

forEachResult - the value of field 'forEachResult'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

unmarshal

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

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