org.opennms.netmgt.config.destinationPaths

Class Path

java.lang.Object

org.opennms.netmgt.config.destinationPaths.Path

All Implemented Interfaces:

Serializable

public class Path
extends Object
implements Serializable

Class Path.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Path()

Method Summary

Modifier and Type	Method and Description
void	addEscalate(Escalate vEscalate)
void	addEscalate(int index, Escalate vEscalate)
void	addTarget(int index, Target vTarget)
void	addTarget(Target vTarget)
Enumeration<Escalate>	enumerateEscalate() Method enumerateEscalate.
Enumeration<Target>	enumerateTarget() Method enumerateTarget.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Escalate[]	getEscalate() Method getEscalate.Returns the contents of the collection in an Array.
Escalate	getEscalate(int index) Method getEscalate.
List<Escalate>	getEscalateCollection() Method getEscalateCollection.Returns a reference to '_escalateList'.
int	getEscalateCount() Method getEscalateCount.
String	getInitialDelay() Returns the value of field 'initialDelay'.
String	getName() Returns the value of field 'name'.
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<Escalate>	iterateEscalate() Method iterateEscalate.
Iterator<Target>	iterateTarget() Method iterateTarget.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllEscalate()
void	removeAllTarget()
boolean	removeEscalate(Escalate vEscalate) Method removeEscalate.
Escalate	removeEscalateAt(int index) Method removeEscalateAt.
boolean	removeTarget(Target vTarget) Method removeTarget.
Target	removeTargetAt(int index) Method removeTargetAt.
void	setEscalate(Escalate[] vEscalateArray)
void	setEscalate(int index, Escalate vEscalate)
void	setEscalate(List<Escalate> vEscalateList) Sets the value of '_escalateList' by copying the given Vector.
void	setEscalateCollection(List<Escalate> escalateList) Deprecated.
void	setInitialDelay(String initialDelay) Sets the value of field 'initialDelay'.
void	setName(String name) Sets the value of field 'name'.
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 Path	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

Path

public Path()

Method Detail

addEscalate

public void addEscalate(Escalate vEscalate)
                 throws IndexOutOfBoundsException

Parameters:

vEscalate -

Throws:

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

addEscalate

public void addEscalate(int index,
                        Escalate vEscalate)
                 throws IndexOutOfBoundsException

Parameters:

index -

vEscalate -

Throws:

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

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

enumerateEscalate

public Enumeration<Escalate> enumerateEscalate()

Method enumerateEscalate.

Returns:

an Enumeration over all possible elements of this 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.

getEscalate

public Escalate getEscalate(int index)
                     throws IndexOutOfBoundsException

Method getEscalate.

Parameters:

index -

Returns:

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

Throws:

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

getEscalate

public Escalate[] getEscalate()

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

getEscalateCollection

public List<Escalate> getEscalateCollection()

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

Returns:

a reference to the Vector backing this class

getEscalateCount

public int getEscalateCount()

Method getEscalateCount.

Returns:

the size of this collection

getInitialDelay

public String getInitialDelay()

Returns the value of field 'initialDelay'.

Returns:

the value of field 'InitialDelay'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

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

iterateEscalate

public Iterator<Escalate> iterateEscalate()

Method iterateEscalate.

Returns:

an Iterator over all possible elements in this collection

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

removeAllEscalate

public void removeAllEscalate()

removeAllTarget

public void removeAllTarget()

removeEscalate

public boolean removeEscalate(Escalate vEscalate)

Method removeEscalate.

Parameters:

vEscalate -

Returns:

true if the object was removed from the collection.

removeEscalateAt

public Escalate removeEscalateAt(int index)

Method removeEscalateAt.

Parameters:

index -

Returns:

the element removed from the collection

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

setEscalate

public void setEscalate(int index,
                        Escalate vEscalate)
                 throws IndexOutOfBoundsException

Parameters:

index -

vEscalate -

Throws:

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

setEscalate

public void setEscalate(Escalate[] vEscalateArray)

Parameters:

vEscalateArray -

setEscalate

public void setEscalate(List<Escalate> vEscalateList)

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

Parameters:

vEscalateList - the Vector to copy.

setEscalateCollection

public void setEscalateCollection(List<Escalate> escalateList)

Deprecated.

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

Parameters:

escalateList - the Vector to set.

setInitialDelay

public void setInitialDelay(String initialDelay)

Sets the value of field 'initialDelay'.

Parameters:

initialDelay - the value of field 'initialDelay'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

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 Path 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.Path

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