org.opennms.netmgt.config.vacuumd

Class Triggers

java.lang.Object

org.opennms.netmgt.config.vacuumd.Triggers

All Implemented Interfaces:

Serializable

public class Triggers
extends Object
implements Serializable

A collection of triggers

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Triggers()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTrigger(int index, Trigger vTrigger)
void	addTrigger(Trigger vTrigger)
Enumeration<Trigger>	enumerateTrigger() Method enumerateTrigger.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Trigger[]	getTrigger() Method getTrigger.Returns the contents of the collection in an Array.
Trigger	getTrigger(int index) Method getTrigger.
List<Trigger>	getTriggerCollection() Method getTriggerCollection.Returns a reference to '_triggerList'.
int	getTriggerCount() Method getTriggerCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Trigger>	iterateTrigger() Method iterateTrigger.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllTrigger()
boolean	removeTrigger(Trigger vTrigger) Method removeTrigger.
Trigger	removeTriggerAt(int index) Method removeTriggerAt.
void	setTrigger(int index, Trigger vTrigger)
void	setTrigger(List<Trigger> vTriggerList) Sets the value of '_triggerList' by copying the given Vector.
void	setTrigger(Trigger[] vTriggerArray)
void	setTriggerCollection(List<Trigger> triggerList) Deprecated.
static Triggers	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

Triggers

public Triggers()

Method Detail

addTrigger

public void addTrigger(Trigger vTrigger)
                throws IndexOutOfBoundsException

Parameters:

vTrigger -

Throws:

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

addTrigger

public void addTrigger(int index,
              Trigger vTrigger)
                throws IndexOutOfBoundsException

Parameters:

index -

vTrigger -

Throws:

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

enumerateTrigger

public Enumeration<Trigger> enumerateTrigger()

Method enumerateTrigger.

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.

getTrigger

public Trigger getTrigger(int index)
                   throws IndexOutOfBoundsException

Method getTrigger.

Parameters:

index -

Returns:

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

Throws:

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

getTrigger

public Trigger[] getTrigger()

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

getTriggerCollection

public List<Trigger> getTriggerCollection()

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

Returns:

a reference to the Vector backing this class

getTriggerCount

public int getTriggerCount()

Method getTriggerCount.

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

iterateTrigger

public Iterator<Trigger> iterateTrigger()

Method iterateTrigger.

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

removeAllTrigger

public void removeAllTrigger()

removeTrigger

public boolean removeTrigger(Trigger vTrigger)

Method removeTrigger.

Parameters:

vTrigger -

Returns:

true if the object was removed from the collection.

removeTriggerAt

public Trigger removeTriggerAt(int index)

Method removeTriggerAt.

Parameters:

index -

Returns:

the element removed from the collection

setTrigger

public void setTrigger(int index,
              Trigger vTrigger)
                throws IndexOutOfBoundsException

Parameters:

index -

vTrigger -

Throws:

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

setTrigger

public void setTrigger(Trigger[] vTriggerArray)

Parameters:

vTriggerArray -

setTrigger

public void setTrigger(List<Trigger> vTriggerList)

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

Parameters:

vTriggerList - the Vector to copy.

setTriggerCollection

public void setTriggerCollection(List<Trigger> triggerList)

Deprecated.

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

Parameters:

triggerList - the Vector to set.

unmarshal

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

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