org.opennms.netmgt.xml.eventconf

Class Mask

java.lang.Object

org.opennms.netmgt.xml.eventconf.Mask

All Implemented Interfaces:

Serializable

public class Mask
extends Object
implements Serializable

The Mask for event configuration: The mask contains one or more 'maskelements' which uniquely identify an event.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Mask()

Method Summary

Modifier and Type	Method and Description
void	addMaskelement(int index, Maskelement element)
void	addMaskelement(Maskelement element)
void	addVarbind(int index, Varbind varbind)
void	addVarbind(Varbind varbind)
EventMatcher	constructMatcher()
Enumeration<Maskelement>	enumerateMaskelement()
Enumeration<Varbind>	enumerateVarbind()
boolean	equals(Object obj)
Maskelement[]	getMaskelement()
Maskelement	getMaskelement(int index)
Maskelement	getMaskElement(String mename)
List<Maskelement>	getMaskelementCollection()
int	getMaskelementCount()
List<String>	getMaskElementValues(String mename)
Varbind[]	getVarbind()
Varbind	getVarbind(int index)
List<Varbind>	getVarbindCollection()
int	getVarbindCount()
int	hashCode()
boolean	isValid()
Iterator<Maskelement>	iterateMaskelement()
Iterator<Varbind>	iterateVarbind()
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllMaskelement()
void	removeAllVarbind()
boolean	removeMaskelement(Maskelement element)
Maskelement	removeMaskelementAt(int index)
boolean	removeVarbind(Varbind varbind)
Varbind	removeVarbindAt(int index)
void	setMaskelement(int index, Maskelement element)
void	setMaskelement(List<Maskelement> elements)
void	setMaskelement(Maskelement[] elements)
void	setMaskelementCollection(List<Maskelement> elements)
void	setVarbind(int index, Varbind varbind)
void	setVarbind(List<Varbind> varbinds)
void	setVarbind(Varbind[] varbinds)
void	setVarbindCollection(List<Varbind> varbinds)
static Mask	unmarshal(Reader reader)
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Mask

public Mask()

Method Detail

addMaskelement

public void addMaskelement(Maskelement element)
                    throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

addMaskelement

public void addMaskelement(int index,
                           Maskelement element)
                    throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

addVarbind

public void addVarbind(Varbind varbind)
                throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

addVarbind

public void addVarbind(int index,
                       Varbind varbind)
                throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

enumerateMaskelement

public Enumeration<Maskelement> enumerateMaskelement()

enumerateVarbind

public Enumeration<Varbind> enumerateVarbind()

getMaskelement

public Maskelement getMaskelement(int index)
                           throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

getMaskelement

public Maskelement[] getMaskelement()

getMaskelementCollection

public List<Maskelement> getMaskelementCollection()

getMaskelementCount

public int getMaskelementCount()

getVarbind

public Varbind getVarbind(int index)
                   throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

getVarbind

public Varbind[] getVarbind()

getVarbindCollection

public List<Varbind> getVarbindCollection()

getVarbindCount

public int getVarbindCount()

isValid

public boolean isValid()

iterateMaskelement

public Iterator<Maskelement> iterateMaskelement()

iterateVarbind

public Iterator<Varbind> iterateVarbind()

marshal

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

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

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

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeAllMaskelement

public void removeAllMaskelement()

removeAllVarbind

public void removeAllVarbind()

removeMaskelement

public boolean removeMaskelement(Maskelement element)

removeMaskelementAt

public Maskelement removeMaskelementAt(int index)

removeVarbind

public boolean removeVarbind(Varbind varbind)

removeVarbindAt

public Varbind removeVarbindAt(int index)

setMaskelement

public void setMaskelement(int index,
                           Maskelement element)
                    throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

setMaskelement

public void setMaskelement(Maskelement[] elements)

setMaskelement

public void setMaskelement(List<Maskelement> elements)

setMaskelementCollection

public void setMaskelementCollection(List<Maskelement> elements)

setVarbind

public void setVarbind(int index,
                       Varbind varbind)
                throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

setVarbind

public void setVarbind(Varbind[] varbinds)

setVarbind

public void setVarbind(List<Varbind> varbinds)

setVarbindCollection

public void setVarbindCollection(List<Varbind> varbinds)

unmarshal

public static Mask unmarshal(Reader reader)
                      throws org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

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

Throws:

org.exolab.castor.xml.ValidationException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

constructMatcher

public EventMatcher constructMatcher()

getMaskElement

public Maskelement getMaskElement(String mename)

getMaskElementValues

public List<String> getMaskElementValues(String mename)