org.opennms.netmgt.config.translator

Class Translation

java.lang.Object

org.opennms.netmgt.config.translator.Translation

All Implemented Interfaces:

Serializable

public class Translation
extends Object
implements Serializable

List of OpenNMS events for which the Event Translator will subscribe for translation.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Translation()

Method Summary

Modifier and Type	Method and Description
void	addEventTranslationSpec(EventTranslationSpec vEventTranslationSpec)
void	addEventTranslationSpec(int index, EventTranslationSpec vEventTranslationSpec)
Enumeration<EventTranslationSpec>	enumerateEventTranslationSpec() Method enumerateEventTranslationSpec.
boolean	equals(Object obj) Overrides the Object.equals method.
EventTranslationSpec[]	getEventTranslationSpec() Method getEventTranslationSpec.Returns the contents of the collection in an Array.
EventTranslationSpec	getEventTranslationSpec(int index) Method getEventTranslationSpec.
List<EventTranslationSpec>	getEventTranslationSpecCollection() Method getEventTranslationSpecCollection.Returns a reference to 'eventTranslationSpecList'.
int	getEventTranslationSpecCount() Method getEventTranslationSpecCount.
int	hashCode() Method hashCode.
Iterator<EventTranslationSpec>	iterateEventTranslationSpec() Method iterateEventTranslationSpec.
void	removeAllEventTranslationSpec()
boolean	removeEventTranslationSpec(EventTranslationSpec vEventTranslationSpec) Method removeEventTranslationSpec.
EventTranslationSpec	removeEventTranslationSpecAt(int index) Method removeEventTranslationSpecAt.
void	setEventTranslationSpec(EventTranslationSpec[] vEventTranslationSpecArray)
void	setEventTranslationSpec(int index, EventTranslationSpec vEventTranslationSpec)
void	setEventTranslationSpec(List<EventTranslationSpec> vEventTranslationSpecList) Sets the value of 'eventTranslationSpecList' by copying the given Vector.
void	setEventTranslationSpecCollection(List<EventTranslationSpec> eventTranslationSpecList) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Translation

public Translation()

Method Detail

addEventTranslationSpec

public void addEventTranslationSpec(EventTranslationSpec vEventTranslationSpec)
                             throws IndexOutOfBoundsException

Parameters:

vEventTranslationSpec -

Throws:

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

addEventTranslationSpec

public void addEventTranslationSpec(int index,
                                    EventTranslationSpec vEventTranslationSpec)
                             throws IndexOutOfBoundsException

Parameters:

index -

vEventTranslationSpec -

Throws:

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

enumerateEventTranslationSpec

public Enumeration<EventTranslationSpec> enumerateEventTranslationSpec()

Method enumerateEventTranslationSpec.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getEventTranslationSpec

public EventTranslationSpec getEventTranslationSpec(int index)
                                             throws IndexOutOfBoundsException

Method getEventTranslationSpec.

Parameters:

index -

Returns:

the value of the EventTranslationSpec at the given index

Throws:

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

getEventTranslationSpec

public EventTranslationSpec[] getEventTranslationSpec()

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

getEventTranslationSpecCollection

public List<EventTranslationSpec> getEventTranslationSpecCollection()

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

Returns:

a reference to the Vector backing this class

getEventTranslationSpecCount

public int getEventTranslationSpecCount()

Method getEventTranslationSpecCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

iterateEventTranslationSpec

public Iterator<EventTranslationSpec> iterateEventTranslationSpec()

Method iterateEventTranslationSpec.

Returns:

an Iterator over all possible elements in this collection

removeAllEventTranslationSpec

public void removeAllEventTranslationSpec()

removeEventTranslationSpec

public boolean removeEventTranslationSpec(EventTranslationSpec vEventTranslationSpec)

Method removeEventTranslationSpec.

Parameters:

vEventTranslationSpec -

Returns:

true if the object was removed from the collection.

removeEventTranslationSpecAt

public EventTranslationSpec removeEventTranslationSpecAt(int index)

Method removeEventTranslationSpecAt.

Parameters:

index -

Returns:

the element removed from the collection

setEventTranslationSpec

public void setEventTranslationSpec(int index,
                                    EventTranslationSpec vEventTranslationSpec)
                             throws IndexOutOfBoundsException

Parameters:

index -

vEventTranslationSpec -

Throws:

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

setEventTranslationSpec

public void setEventTranslationSpec(EventTranslationSpec[] vEventTranslationSpecArray)

Parameters:

vEventTranslationSpecArray -

setEventTranslationSpec

public void setEventTranslationSpec(List<EventTranslationSpec> vEventTranslationSpecList)

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

Parameters:

vEventTranslationSpecList - the Vector to copy.

setEventTranslationSpecCollection

public void setEventTranslationSpecCollection(List<EventTranslationSpec> eventTranslationSpecList)

Deprecated.

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

Parameters:

eventTranslationSpecList - the Vector to set.