org.opennms.netmgt.config.notifd

Class AutoAcknowledgeAlarm

java.lang.Object

org.opennms.netmgt.config.notifd.AutoAcknowledgeAlarm

All Implemented Interfaces:

Serializable

public class AutoAcknowledgeAlarm
extends Object
implements Serializable

Class AutoAcknowledgeAlarm.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AutoAcknowledgeAlarm()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUei(int index, String vUei)
void	addUei(String vUei)
void	deleteNotify()
Enumeration<String>	enumerateUei() Method enumerateUei.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
boolean	getNotify() Returns the value of field 'notify'.
String	getResolutionPrefix() Returns the value of field 'resolutionPrefix'.
String[]	getUei() Method getUei.Returns the contents of the collection in an Array.
String	getUei(int index) Method getUei.
List<String>	getUeiCollection() Method getUeiCollection.Returns a reference to '_ueiList'.
int	getUeiCount() Method getUeiCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasNotify() Method hasNotify.
boolean	isNotify() Returns the value of field 'notify'.
boolean	isValid() Method isValid.
Iterator<String>	iterateUei() Method iterateUei.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllUei()
boolean	removeUei(String vUei) Method removeUei.
String	removeUeiAt(int index) Method removeUeiAt.
void	setNotify(boolean notify) Sets the value of field 'notify'.
void	setResolutionPrefix(String resolutionPrefix) Sets the value of field 'resolutionPrefix'.
void	setUei(int index, String vUei)
void	setUei(List<String> vUeiList) Sets the value of '_ueiList' by copying the given Vector.
void	setUei(String[] vUeiArray)
void	setUeiCollection(List<String> ueiList) Deprecated.
static AutoAcknowledgeAlarm	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

AutoAcknowledgeAlarm

public AutoAcknowledgeAlarm()

Method Detail

addUei

public void addUei(String vUei)
            throws IndexOutOfBoundsException

Parameters:

vUei -

Throws:

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

addUei

public void addUei(int index,
          String vUei)
            throws IndexOutOfBoundsException

Parameters:

index -

vUei -

Throws:

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

deleteNotify

public void deleteNotify()

enumerateUei

public Enumeration<String> enumerateUei()

Method enumerateUei.

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.

getNotify

public boolean getNotify()

Returns the value of field 'notify'.

Returns:

the value of field 'Notify'.

getResolutionPrefix

public String getResolutionPrefix()

Returns the value of field 'resolutionPrefix'.

Returns:

the value of field 'ResolutionPrefix'.

getUei

public String getUei(int index)
              throws IndexOutOfBoundsException

Method getUei.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

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

getUei

public String[] getUei()

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

getUeiCollection

public List<String> getUeiCollection()

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

Returns:

a reference to the Vector backing this class

getUeiCount

public int getUeiCount()

Method getUeiCount.

Returns:

the size of this collection

hasNotify

public boolean hasNotify()

Method hasNotify.

Returns:

true if at least one Notify has been added

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.

isNotify

public boolean isNotify()

Returns the value of field 'notify'.

Returns:

the value of field 'Notify'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateUei

public Iterator<String> iterateUei()

Method iterateUei.

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

removeAllUei

public void removeAllUei()

removeUei

public boolean removeUei(String vUei)

Method removeUei.

Parameters:

vUei -

Returns:

true if the object was removed from the collection.

removeUeiAt

public String removeUeiAt(int index)

Method removeUeiAt.

Parameters:

index -

Returns:

the element removed from the collection

setNotify

public void setNotify(boolean notify)

Sets the value of field 'notify'.

Parameters:

notify - the value of field 'notify'.

setResolutionPrefix

public void setResolutionPrefix(String resolutionPrefix)

Sets the value of field 'resolutionPrefix'.

Parameters:

resolutionPrefix - the value of field 'resolutionPrefix'

setUei

public void setUei(int index,
          String vUei)
            throws IndexOutOfBoundsException

Parameters:

index -

vUei -

Throws:

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

setUei

public void setUei(String[] vUeiArray)

Parameters:

vUeiArray -

setUei

public void setUei(List<String> vUeiList)

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

Parameters:

vUeiList - the Vector to copy.

setUeiCollection

public void setUeiCollection(List<String> ueiList)

Deprecated.

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

Parameters:

ueiList - the Vector to set.

unmarshal

public static AutoAcknowledgeAlarm 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.notifd.AutoAcknowledgeAlarm

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