org.opennms.netmgt.config.snmpinterfacepoller
Class NodeOutage

java.lang.Object
  org.opennms.netmgt.config.snmpinterfacepoller.NodeOutage

All Implemented Interfaces:

Serializable

public class NodeOutage
extends Object
implements Serializable

Configuration of node-outage functionality

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

NodeOutage()

Method Summary

void	addCriticalService(CriticalService vCriticalService)
void	addCriticalService(int index, CriticalService vCriticalService)
Enumeration<CriticalService>	enumerateCriticalService() Method enumerateCriticalService.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
CriticalService[]	getCriticalService() Method getCriticalService.Returns the contents of the collection in an Array.
CriticalService	getCriticalService(int index) Method getCriticalService.
List<CriticalService>	getCriticalServiceCollection() Method getCriticalServiceCollection.Returns a reference to '_criticalServiceList'.
int	getCriticalServiceCount() Method getCriticalServiceCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<CriticalService>	iterateCriticalService() Method iterateCriticalService.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllCriticalService()
boolean	removeCriticalService(CriticalService vCriticalService) Method removeCriticalService.
CriticalService	removeCriticalServiceAt(int index) Method removeCriticalServiceAt.
void	setCriticalService(CriticalService[] vCriticalServiceArray)
void	setCriticalService(int index, CriticalService vCriticalService)
void	setCriticalService(List<CriticalService> vCriticalServiceList) Sets the value of '_criticalServiceList' by copying the given Vector.
void	setCriticalServiceCollection(List<CriticalService> criticalServiceList) Deprecated.
static NodeOutage	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

NodeOutage

public NodeOutage()

Method Detail

addCriticalService

public void addCriticalService(CriticalService vCriticalService)
                        throws IndexOutOfBoundsException

Parameters:

vCriticalService -

Throws:

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

addCriticalService

public void addCriticalService(int index,
                               CriticalService vCriticalService)
                        throws IndexOutOfBoundsException

Parameters:

index -

vCriticalService -

Throws:

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

enumerateCriticalService

public Enumeration<CriticalService> enumerateCriticalService()

Method enumerateCriticalService.

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.

getCriticalService

public CriticalService getCriticalService(int index)
                                   throws IndexOutOfBoundsException

Method getCriticalService.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.snmpinterfacepoller.CriticalService at the given index

Throws:

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

getCriticalService

public CriticalService[] getCriticalService()

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

getCriticalServiceCollection

public List<CriticalService> getCriticalServiceCollection()

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

Returns:

a reference to the Vector backing this class

getCriticalServiceCount

public int getCriticalServiceCount()

Method getCriticalServiceCount.

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

iterateCriticalService

public Iterator<CriticalService> iterateCriticalService()

Method iterateCriticalService.

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

removeAllCriticalService

public void removeAllCriticalService()

removeCriticalService

public boolean removeCriticalService(CriticalService vCriticalService)

Method removeCriticalService.

Parameters:

vCriticalService -

Returns:

true if the object was removed from the collection.

removeCriticalServiceAt

public CriticalService removeCriticalServiceAt(int index)

Method removeCriticalServiceAt.

Parameters:

index -

Returns:

the element removed from the collection

setCriticalService

public void setCriticalService(int index,
                               CriticalService vCriticalService)
                        throws IndexOutOfBoundsException

Parameters:

index -

vCriticalService -

Throws:

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

setCriticalService

public void setCriticalService(CriticalService[] vCriticalServiceArray)

Parameters:

vCriticalServiceArray -

setCriticalService

public void setCriticalService(List<CriticalService> vCriticalServiceList)

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

Parameters:

vCriticalServiceList - the Vector to copy.

setCriticalServiceCollection

public void setCriticalServiceCollection(List<CriticalService> criticalServiceList)

Deprecated.

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

Parameters:

criticalServiceList - the Vector to set.

unmarshal

public static NodeOutage 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.snmpinterfacepoller.NodeOutage

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