org.opennms.netmgt.config.vacuumd

Class AutoEvents

java.lang.Object

org.opennms.netmgt.config.vacuumd.AutoEvents

All Implemented Interfaces:

Serializable

public class AutoEvents
extends Object
implements Serializable

Class AutoEvents.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AutoEvents()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAutoEvent(AutoEvent vAutoEvent)
void	addAutoEvent(int index, AutoEvent vAutoEvent)
Enumeration<AutoEvent>	enumerateAutoEvent() Method enumerateAutoEvent.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
AutoEvent[]	getAutoEvent() Method getAutoEvent.Returns the contents of the collection in an Array.
AutoEvent	getAutoEvent(int index) Method getAutoEvent.
List<AutoEvent>	getAutoEventCollection() Method getAutoEventCollection.Returns a reference to '_autoEventList'.
int	getAutoEventCount() Method getAutoEventCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<AutoEvent>	iterateAutoEvent() Method iterateAutoEvent.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllAutoEvent()
boolean	removeAutoEvent(AutoEvent vAutoEvent) Method removeAutoEvent.
AutoEvent	removeAutoEventAt(int index) Method removeAutoEventAt.
void	setAutoEvent(AutoEvent[] vAutoEventArray)
void	setAutoEvent(int index, AutoEvent vAutoEvent)
void	setAutoEvent(List<AutoEvent> vAutoEventList) Sets the value of '_autoEventList' by copying the given Vector.
void	setAutoEventCollection(List<AutoEvent> autoEventList) Deprecated.
static AutoEvents	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

AutoEvents

public AutoEvents()

Method Detail

addAutoEvent

public void addAutoEvent(AutoEvent vAutoEvent)
                  throws IndexOutOfBoundsException

Parameters:

vAutoEvent -

Throws:

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

addAutoEvent

public void addAutoEvent(int index,
                AutoEvent vAutoEvent)
                  throws IndexOutOfBoundsException

Parameters:

index -

vAutoEvent -

Throws:

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

enumerateAutoEvent

public Enumeration<AutoEvent> enumerateAutoEvent()

Method enumerateAutoEvent.

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.

getAutoEvent

public AutoEvent getAutoEvent(int index)
                       throws IndexOutOfBoundsException

Method getAutoEvent.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.vacuumd.AutoEvent at the given inde

Throws:

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

getAutoEvent

public AutoEvent[] getAutoEvent()

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

getAutoEventCollection

public List<AutoEvent> getAutoEventCollection()

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

Returns:

a reference to the Vector backing this class

getAutoEventCount

public int getAutoEventCount()

Method getAutoEventCount.

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

iterateAutoEvent

public Iterator<AutoEvent> iterateAutoEvent()

Method iterateAutoEvent.

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

removeAllAutoEvent

public void removeAllAutoEvent()

removeAutoEvent

public boolean removeAutoEvent(AutoEvent vAutoEvent)

Method removeAutoEvent.

Parameters:

vAutoEvent -

Returns:

true if the object was removed from the collection.

removeAutoEventAt

public AutoEvent removeAutoEventAt(int index)

Method removeAutoEventAt.

Parameters:

index -

Returns:

the element removed from the collection

setAutoEvent

public void setAutoEvent(int index,
                AutoEvent vAutoEvent)
                  throws IndexOutOfBoundsException

Parameters:

index -

vAutoEvent -

Throws:

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

setAutoEvent

public void setAutoEvent(AutoEvent[] vAutoEventArray)

Parameters:

vAutoEventArray -

setAutoEvent

public void setAutoEvent(List<AutoEvent> vAutoEventList)

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

Parameters:

vAutoEventList - the Vector to copy.

setAutoEventCollection

public void setAutoEventCollection(List<AutoEvent> autoEventList)

Deprecated.

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

Parameters:

autoEventList - the Vector to set.

unmarshal

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

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