org.opennms.netmgt.config.notifd
Class AutoAcknowledge

java.lang.Object
  org.opennms.netmgt.config.notifd.AutoAcknowledge

All Implemented Interfaces:

Serializable

public class AutoAcknowledge
extends Object
implements Serializable

Class AutoAcknowledge.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

AutoAcknowledge()

Method Summary

void	addMatch(int index, String vMatch)
void	addMatch(String vMatch)
void	deleteNotify()
Enumeration<String>	enumerateMatch() Method enumerateMatch.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getAcknowledge() Returns the value of field 'acknowledge'.
String[]	getMatch() Method getMatch.Returns the contents of the collection in an Array.
String	getMatch(int index) Method getMatch.
List<String>	getMatchCollection() Method getMatchCollection.Returns a reference to '_matchList'.
int	getMatchCount() Method getMatchCount.
boolean	getNotify() Returns the value of field 'notify'.
String	getResolutionPrefix() Returns the value of field 'resolutionPrefix'.
String	getUei() Returns the value of field 'uei'.
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>	iterateMatch() Method iterateMatch.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllMatch()
boolean	removeMatch(String vMatch) Method removeMatch.
String	removeMatchAt(int index) Method removeMatchAt.
void	setAcknowledge(String acknowledge) Sets the value of field 'acknowledge'.
void	setMatch(int index, String vMatch)
void	setMatch(List<String> vMatchList) Sets the value of '_matchList' by copying the given Vector.
void	setMatch(String[] vMatchArray)
void	setMatchCollection(List<String> matchList) Deprecated.
void	setNotify(boolean notify) Sets the value of field 'notify'.
void	setResolutionPrefix(String resolutionPrefix) Sets the value of field 'resolutionPrefix'.
void	setUei(String uei) Sets the value of field 'uei'.
static AutoAcknowledge	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

AutoAcknowledge

public AutoAcknowledge()

Method Detail

addMatch

public void addMatch(String vMatch)
              throws IndexOutOfBoundsException

Parameters:

vMatch -

Throws:

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

addMatch

public void addMatch(int index,
                     String vMatch)
              throws IndexOutOfBoundsException

Parameters:

index -

vMatch -

Throws:

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

deleteNotify

public void deleteNotify()

enumerateMatch

public Enumeration<String> enumerateMatch()

Method enumerateMatch.

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.

getAcknowledge

public String getAcknowledge()

Returns the value of field 'acknowledge'.

Returns:

the value of field 'Acknowledge'.

getMatch

public String getMatch(int index)
                throws IndexOutOfBoundsException

Method getMatch.

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

getMatch

public String[] getMatch()

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

getMatchCollection

public List<String> getMatchCollection()

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

Returns:

a reference to the Vector backing this class

getMatchCount

public int getMatchCount()

Method getMatchCount.

Returns:

the size of this collection

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()

Returns the value of field 'uei'.

Returns:

the value of field 'Uei'.

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

iterateMatch

public Iterator<String> iterateMatch()

Method iterateMatch.

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

removeAllMatch

public void removeAllMatch()

removeMatch

public boolean removeMatch(String vMatch)

Method removeMatch.

Parameters:

vMatch -

Returns:

true if the object was removed from the collection.

removeMatchAt

public String removeMatchAt(int index)

Method removeMatchAt.

Parameters:

index -

Returns:

the element removed from the collection

setAcknowledge

public void setAcknowledge(String acknowledge)

Sets the value of field 'acknowledge'.

Parameters:

acknowledge - the value of field 'acknowledge'.

setMatch

public void setMatch(int index,
                     String vMatch)
              throws IndexOutOfBoundsException

Parameters:

index -

vMatch -

Throws:

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

setMatch

public void setMatch(String[] vMatchArray)

Parameters:

vMatchArray -

setMatch

public void setMatch(List<String> vMatchList)

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

Parameters:

vMatchList - the Vector to copy.

setMatchCollection

public void setMatchCollection(List<String> matchList)

Deprecated.

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

Parameters:

matchList - the Vector to set.

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(String uei)

Sets the value of field 'uei'.

Parameters:

uei - the value of field 'uei'.

unmarshal

public static AutoAcknowledge 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.AutoAcknowledge

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