org.opennms.netmgt.config.notifications

Class Notifications

java.lang.Object

org.opennms.netmgt.config.notifications.Notifications

All Implemented Interfaces:

Serializable

public class Notifications
extends Object
implements Serializable

Top-level element for the notifications.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Notifications()

Method Summary

Modifier and Type	Method and Description
void	addNotification(int index, Notification vNotification)
void	addNotification(Notification vNotification)
Enumeration<Notification>	enumerateNotification() Method enumerateNotification.
boolean	equals(Object obj) Overrides the Object.equals method.
Header	getHeader() Returns the value of field 'header'.
Notification[]	getNotification() Method getNotification.Returns the contents of the collection in an Array.
Notification	getNotification(int index) Method getNotification.
List<Notification>	getNotificationCollection() Method getNotificationCollection.Returns a reference to 'notificationList'.
int	getNotificationCount() Method getNotificationCount.
int	hashCode() Method hashCode.
Iterator<Notification>	iterateNotification() Method iterateNotification.
void	removeAllNotification()
boolean	removeNotification(Notification vNotification) Method removeNotification.
Notification	removeNotificationAt(int index) Method removeNotificationAt.
void	setHeader(Header header) Sets the value of field 'header'.
void	setNotification(int index, Notification vNotification)
void	setNotification(List<Notification> vNotificationList) Sets the value of 'notificationList' by copying the given Vector.
void	setNotification(Notification[] vNotificationArray)
void	setNotificationCollection(List<Notification> notificationList) Deprecated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Notifications

public Notifications()

Method Detail

addNotification

public void addNotification(Notification vNotification)
                     throws IndexOutOfBoundsException

Parameters:

vNotification -

Throws:

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

addNotification

public void addNotification(int index,
                            Notification vNotification)
                     throws IndexOutOfBoundsException

Parameters:

index -

vNotification -

Throws:

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

enumerateNotification

public Enumeration<Notification> enumerateNotification()

Method enumerateNotification.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getHeader

public Header getHeader()

Returns the value of field 'header'. The field 'header' has the following description: Header containing information about this configuration file.

Returns:

the value of field 'Header'.

getNotification

public Notification getNotification(int index)
                             throws IndexOutOfBoundsException

Method getNotification.

Parameters:

index -

Returns:

the value of the Notification at the given index

Throws:

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

getNotification

public Notification[] getNotification()

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

getNotificationCollection

public List<Notification> getNotificationCollection()

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

Returns:

a reference to the Vector backing this class

getNotificationCount

public int getNotificationCount()

Method getNotificationCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

iterateNotification

public Iterator<Notification> iterateNotification()

Method iterateNotification.

Returns:

an Iterator over all possible elements in this collection

removeAllNotification

public void removeAllNotification()

removeNotification

public boolean removeNotification(Notification vNotification)

Method removeNotification.

Parameters:

vNotification -

Returns:

true if the object was removed from the collection.

removeNotificationAt

public Notification removeNotificationAt(int index)

Method removeNotificationAt.

Parameters:

index -

Returns:

the element removed from the collection

setHeader

public void setHeader(Header header)

Sets the value of field 'header'. The field 'header' has the following description: Header containing information about this configuration file.

Parameters:

header - the value of field 'header'.

setNotification

public void setNotification(int index,
                            Notification vNotification)
                     throws IndexOutOfBoundsException

Parameters:

index -

vNotification -

Throws:

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

setNotification

public void setNotification(Notification[] vNotificationArray)

Parameters:

vNotificationArray -

setNotification

public void setNotification(List<Notification> vNotificationList)

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

Parameters:

vNotificationList - the Vector to copy.

setNotificationCollection

public void setNotificationCollection(List<Notification> notificationList)

Deprecated.

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

Parameters:

notificationList - the Vector to set.