org.opennms.netmgt.xml.event
Class Mask

java.lang.Object
  org.opennms.netmgt.xml.event.Mask

All Implemented Interfaces:

java.io.Serializable

public class Mask
extends java.lang.Object
implements java.io.Serializable

The Mask for event configuration: The mask contains one or more 'maskelements' which uniquely identify an event. This can only include elements from the following subset: uei, source, host, snmphost, nodeid, interface, service, id(SNMP EID), specific, generic, community

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Mask()

Method Summary

void	addMaskelement(int index, Maskelement vMaskelement) Method addMaskelement
void	addMaskelement(Maskelement vMaskelement) Method addMaskelement
void	clearMaskelement() Method clearMaskelement
java.util.Enumeration	enumerateMaskelement() Method enumerateMaskelement
Maskelement[]	getMaskelement() Method getMaskelement
Maskelement	getMaskelement(int index) Method getMaskelement
java.util.ArrayList	getMaskelementCollection() Method getMaskelementCollection Returns a reference to 'maskelement'.
int	getMaskelementCount() Method getMaskelementCount
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
boolean	removeMaskelement(Maskelement vMaskelement) Method removeMaskelement
void	setMaskelement(java.util.ArrayList maskelementCollection) Method setMaskelement Sets the value of 'maskelement' by copying the given ArrayList.
void	setMaskelement(int index, Maskelement vMaskelement) Method setMaskelement
void	setMaskelement(Maskelement[] maskelementArray) Method setMaskelement
void	setMaskelementCollection(java.util.ArrayList maskelementCollection) Method setMaskelementCollection Sets the value of 'maskelement' by setting it to the given ArrayList.
static java.lang.Object	unmarshal(java.io.Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Mask

public Mask()

Method Detail

addMaskelement

public void addMaskelement(Maskelement vMaskelement)
                    throws java.lang.IndexOutOfBoundsException

Method addMaskelement

Parameters:

vMaskelement -

Throws:

java.lang.IndexOutOfBoundsException

addMaskelement

public void addMaskelement(int index,
                           Maskelement vMaskelement)
                    throws java.lang.IndexOutOfBoundsException

Method addMaskelement

Parameters:

index -

vMaskelement -

Throws:

java.lang.IndexOutOfBoundsException

clearMaskelement

public void clearMaskelement()

Method clearMaskelement

enumerateMaskelement

public java.util.Enumeration enumerateMaskelement()

Method enumerateMaskelement

Returns:

Enumeration

getMaskelement

public Maskelement getMaskelement(int index)
                           throws java.lang.IndexOutOfBoundsException

Method getMaskelement

Parameters:

index -

Returns:

Maskelement

Throws:

java.lang.IndexOutOfBoundsException

getMaskelement

public Maskelement[] getMaskelement()

Method getMaskelement

Returns:

Maskelement

getMaskelementCollection

public java.util.ArrayList getMaskelementCollection()

Method getMaskelementCollection Returns a reference to 'maskelement'. No type checking is performed on any modications to the Collection.

Returns:

ArrayList

getMaskelementCount

public int getMaskelementCount()

Method getMaskelementCount

Returns:

int

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeMaskelement

public boolean removeMaskelement(Maskelement vMaskelement)

Method removeMaskelement

Parameters:

vMaskelement -

Returns:

boolean

setMaskelement

public void setMaskelement(int index,
                           Maskelement vMaskelement)
                    throws java.lang.IndexOutOfBoundsException

Method setMaskelement

Parameters:

index -

vMaskelement -

Throws:

java.lang.IndexOutOfBoundsException

setMaskelement

public void setMaskelement(Maskelement[] maskelementArray)

Method setMaskelement

Parameters:

maskelementArray -

setMaskelement

public void setMaskelement(java.util.ArrayList maskelementCollection)

Method setMaskelement Sets the value of 'maskelement' by copying the given ArrayList.

Parameters:

maskelementCollection - the Vector to copy.

setMaskelementCollection

public void setMaskelementCollection(java.util.ArrayList maskelementCollection)

Method setMaskelementCollection Sets the value of 'maskelement' by setting it to the given ArrayList. No type checking is performed.

Parameters:

maskelementCollection - the ArrayList to copy.

unmarshal

public static java.lang.Object unmarshal(java.io.Reader reader)
                                  throws org.exolab.castor.xml.MarshalException,
                                         org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Returns:

Object

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException