org.opennms.netmgt.config.destinationPaths

Class Escalate

java.lang.Object

org.opennms.netmgt.config.destinationPaths.Escalate

All Implemented Interfaces:

Serializable

public class Escalate
extends Object
implements Serializable

Class Escalate.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Escalate()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTarget(int index, Target vTarget)
void	addTarget(Target vTarget)
Enumeration<Target>	enumerateTarget() Method enumerateTarget.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDelay() Returns the value of field 'delay'.
Target[]	getTarget() Method getTarget.Returns the contents of the collection in an Array.
Target	getTarget(int index) Method getTarget.
List<Target>	getTargetCollection() Method getTargetCollection.Returns a reference to '_targetList'.
int	getTargetCount() Method getTargetCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Target>	iterateTarget() Method iterateTarget.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllTarget()
boolean	removeTarget(Target vTarget) Method removeTarget.
Target	removeTargetAt(int index) Method removeTargetAt.
void	setDelay(String delay) Sets the value of field 'delay'.
void	setTarget(int index, Target vTarget)
void	setTarget(List<Target> vTargetList) Sets the value of '_targetList' by copying the given Vector.
void	setTarget(Target[] vTargetArray)
void	setTargetCollection(List<Target> targetList) Deprecated.
static Escalate	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

Escalate

public Escalate()

Method Detail

addTarget

public void addTarget(Target vTarget)
               throws IndexOutOfBoundsException

Parameters:

vTarget -

Throws:

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

addTarget

public void addTarget(int index,
             Target vTarget)
               throws IndexOutOfBoundsException

Parameters:

index -

vTarget -

Throws:

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

enumerateTarget

public Enumeration<Target> enumerateTarget()

Method enumerateTarget.

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.

getDelay

public String getDelay()

Returns the value of field 'delay'.

Returns:

the value of field 'Delay'.

getTarget

public Target getTarget(int index)
                 throws IndexOutOfBoundsException

Method getTarget.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.destinationPaths.Target at the given index

Throws:

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

getTarget

public Target[] getTarget()

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

getTargetCollection

public List<Target> getTargetCollection()

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

Returns:

a reference to the Vector backing this class

getTargetCount

public int getTargetCount()

Method getTargetCount.

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

iterateTarget

public Iterator<Target> iterateTarget()

Method iterateTarget.

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

removeAllTarget

public void removeAllTarget()

removeTarget

public boolean removeTarget(Target vTarget)

Method removeTarget.

Parameters:

vTarget -

Returns:

true if the object was removed from the collection.

removeTargetAt

public Target removeTargetAt(int index)

Method removeTargetAt.

Parameters:

index -

Returns:

the element removed from the collection

setDelay

public void setDelay(String delay)

Sets the value of field 'delay'.

Parameters:

delay - the value of field 'delay'.

setTarget

public void setTarget(int index,
             Target vTarget)
               throws IndexOutOfBoundsException

Parameters:

index -

vTarget -

Throws:

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

setTarget

public void setTarget(Target[] vTargetArray)

Parameters:

vTargetArray -

setTarget

public void setTarget(List<Target> vTargetList)

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

Parameters:

vTargetList - the Vector to copy.

setTargetCollection

public void setTargetCollection(List<Target> targetList)

Deprecated.

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

Parameters:

targetList - the Vector to set.

unmarshal

public static Escalate 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.destinationPaths.Escalate

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