org.opennms.netmgt.config.vacuumd

Class Automations

java.lang.Object

org.opennms.netmgt.config.vacuumd.Automations

All Implemented Interfaces:

Serializable

public class Automations
extends Object
implements Serializable

Class Automations.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Automations()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAutomation(Automation vAutomation)
void	addAutomation(int index, Automation vAutomation)
Enumeration<Automation>	enumerateAutomation() Method enumerateAutomation.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Automation[]	getAutomation() Method getAutomation.Returns the contents of the collection in an Array.
Automation	getAutomation(int index) Method getAutomation.
List<Automation>	getAutomationCollection() Method getAutomationCollection.Returns a reference to '_automationList'.
int	getAutomationCount() Method getAutomationCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Automation>	iterateAutomation() Method iterateAutomation.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllAutomation()
boolean	removeAutomation(Automation vAutomation) Method removeAutomation.
Automation	removeAutomationAt(int index) Method removeAutomationAt.
void	setAutomation(Automation[] vAutomationArray)
void	setAutomation(int index, Automation vAutomation)
void	setAutomation(List<Automation> vAutomationList) Sets the value of '_automationList' by copying the given Vector.
void	setAutomationCollection(List<Automation> automationList) Deprecated.
static Automations	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

Automations

public Automations()

Method Detail

addAutomation

public void addAutomation(Automation vAutomation)
                   throws IndexOutOfBoundsException

Parameters:

vAutomation -

Throws:

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

addAutomation

public void addAutomation(int index,
                 Automation vAutomation)
                   throws IndexOutOfBoundsException

Parameters:

index -

vAutomation -

Throws:

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

enumerateAutomation

public Enumeration<Automation> enumerateAutomation()

Method enumerateAutomation.

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.

getAutomation

public Automation getAutomation(int index)
                         throws IndexOutOfBoundsException

Method getAutomation.

Parameters:

index -

Returns:

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

Throws:

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

getAutomation

public Automation[] getAutomation()

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

getAutomationCollection

public List<Automation> getAutomationCollection()

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

Returns:

a reference to the Vector backing this class

getAutomationCount

public int getAutomationCount()

Method getAutomationCount.

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

iterateAutomation

public Iterator<Automation> iterateAutomation()

Method iterateAutomation.

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

removeAllAutomation

public void removeAllAutomation()

removeAutomation

public boolean removeAutomation(Automation vAutomation)

Method removeAutomation.

Parameters:

vAutomation -

Returns:

true if the object was removed from the collection.

removeAutomationAt

public Automation removeAutomationAt(int index)

Method removeAutomationAt.

Parameters:

index -

Returns:

the element removed from the collection

setAutomation

public void setAutomation(int index,
                 Automation vAutomation)
                   throws IndexOutOfBoundsException

Parameters:

index -

vAutomation -

Throws:

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

setAutomation

public void setAutomation(Automation[] vAutomationArray)

Parameters:

vAutomationArray -

setAutomation

public void setAutomation(List<Automation> vAutomationList)

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

Parameters:

vAutomationList - the Vector to copy.

setAutomationCollection

public void setAutomationCollection(List<Automation> automationList)

Deprecated.

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

Parameters:

automationList - the Vector to set.

unmarshal

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

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