org.opennms.netmgt.config.translator

Class Mappings

java.lang.Object

org.opennms.netmgt.config.translator.Mappings

All Implemented Interfaces:

Serializable

public class Mappings
extends Object
implements Serializable

The list of event mappings for this event. The first mapping that matches the event is used to translate the event into a new event.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Mappings()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMapping(int index, Mapping vMapping)
void	addMapping(Mapping vMapping)
Enumeration<Mapping>	enumerateMapping() Method enumerateMapping.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Mapping[]	getMapping() Method getMapping.Returns the contents of the collection in an Array.
Mapping	getMapping(int index) Method getMapping.
List<Mapping>	getMappingCollection() Method getMappingCollection.Returns a reference to '_mappingList'.
int	getMappingCount() Method getMappingCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Mapping>	iterateMapping() Method iterateMapping.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllMapping()
boolean	removeMapping(Mapping vMapping) Method removeMapping.
Mapping	removeMappingAt(int index) Method removeMappingAt.
void	setMapping(int index, Mapping vMapping)
void	setMapping(List<Mapping> vMappingList) Sets the value of '_mappingList' by copying the given Vector.
void	setMapping(Mapping[] vMappingArray)
void	setMappingCollection(List<Mapping> mappingList) Deprecated.
static Mappings	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

Mappings

public Mappings()

Method Detail

addMapping

public void addMapping(Mapping vMapping)
                throws IndexOutOfBoundsException

Parameters:

vMapping -

Throws:

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

addMapping

public void addMapping(int index,
              Mapping vMapping)
                throws IndexOutOfBoundsException

Parameters:

index -

vMapping -

Throws:

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

enumerateMapping

public Enumeration<Mapping> enumerateMapping()

Method enumerateMapping.

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.

getMapping

public Mapping getMapping(int index)
                   throws IndexOutOfBoundsException

Method getMapping.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.translator.Mapping at the given index

Throws:

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

getMapping

public Mapping[] getMapping()

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

getMappingCollection

public List<Mapping> getMappingCollection()

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

Returns:

a reference to the Vector backing this class

getMappingCount

public int getMappingCount()

Method getMappingCount.

Returns:

the size of this collection

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.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateMapping

public Iterator<Mapping> iterateMapping()

Method iterateMapping.

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

removeAllMapping

public void removeAllMapping()

removeMapping

public boolean removeMapping(Mapping vMapping)

Method removeMapping.

Parameters:

vMapping -

Returns:

true if the object was removed from the collection.

removeMappingAt

public Mapping removeMappingAt(int index)

Method removeMappingAt.

Parameters:

index -

Returns:

the element removed from the collection

setMapping

public void setMapping(int index,
              Mapping vMapping)
                throws IndexOutOfBoundsException

Parameters:

index -

vMapping -

Throws:

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

setMapping

public void setMapping(Mapping[] vMappingArray)

Parameters:

vMappingArray -

setMapping

public void setMapping(List<Mapping> vMappingList)

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

Parameters:

vMappingList - the Vector to copy.

setMappingCollection

public void setMappingCollection(List<Mapping> mappingList)

Deprecated.

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

Parameters:

mappingList - the Vector to set.

unmarshal

public static Mappings 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.translator.Mappings

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