org.opennms.netmgt.config.scriptd

Class EventScript

java.lang.Object

org.opennms.netmgt.config.scriptd.EventScript

All Implemented Interfaces:

Serializable

public class EventScript
extends Object
implements Serializable

Class EventScript.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EventScript()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUei(int index, Uei vUei)
void	addUei(Uei vUei)
Enumeration<Uei>	enumerateUei() Method enumerateUei.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getContent() Returns the value of field 'content'.
String	getLanguage() Returns the value of field 'language'.
Uei[]	getUei() Method getUei.Returns the contents of the collection in an Array.
Uei	getUei(int index) Method getUei.
List<Uei>	getUeiCollection() Method getUeiCollection.Returns a reference to '_ueiList'.
int	getUeiCount() Method getUeiCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Uei>	iterateUei() Method iterateUei.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllUei()
boolean	removeUei(Uei vUei) Method removeUei.
Uei	removeUeiAt(int index) Method removeUeiAt.
void	setContent(String content) Sets the value of field 'content'.
void	setLanguage(String language) Sets the value of field 'language'.
void	setUei(int index, Uei vUei)
void	setUei(List<Uei> vUeiList) Sets the value of '_ueiList' by copying the given Vector.
void	setUei(Uei[] vUeiArray)
void	setUeiCollection(List<Uei> ueiList) Deprecated.
static EventScript	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

EventScript

public EventScript()

Method Detail

addUei

public void addUei(Uei vUei)
            throws IndexOutOfBoundsException

Parameters:

vUei -

Throws:

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

addUei

public void addUei(int index,
          Uei vUei)
            throws IndexOutOfBoundsException

Parameters:

index -

vUei -

Throws:

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

enumerateUei

public Enumeration<Uei> enumerateUei()

Method enumerateUei.

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.

getContent

public String getContent()

Returns the value of field 'content'. The field 'content' has the following description: internal content storage

Returns:

the value of field 'Content'.

getLanguage

public String getLanguage()

Returns the value of field 'language'.

Returns:

the value of field 'Language'.

getUei

public Uei getUei(int index)
           throws IndexOutOfBoundsException

Method getUei.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.scriptd.Uei at the given index

Throws:

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

getUei

public Uei[] getUei()

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

getUeiCollection

public List<Uei> getUeiCollection()

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

Returns:

a reference to the Vector backing this class

getUeiCount

public int getUeiCount()

Method getUeiCount.

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

iterateUei

public Iterator<Uei> iterateUei()

Method iterateUei.

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

removeAllUei

public void removeAllUei()

removeUei

public boolean removeUei(Uei vUei)

Method removeUei.

Parameters:

vUei -

Returns:

true if the object was removed from the collection.

removeUeiAt

public Uei removeUeiAt(int index)

Method removeUeiAt.

Parameters:

index -

Returns:

the element removed from the collection

setContent

public void setContent(String content)

Sets the value of field 'content'. The field 'content' has the following description: internal content storage

Parameters:

content - the value of field 'content'.

setLanguage

public void setLanguage(String language)

Sets the value of field 'language'.

Parameters:

language - the value of field 'language'.

setUei

public void setUei(int index,
          Uei vUei)
            throws IndexOutOfBoundsException

Parameters:

index -

vUei -

Throws:

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

setUei

public void setUei(Uei[] vUeiArray)

Parameters:

vUeiArray -

setUei

public void setUei(List<Uei> vUeiList)

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

Parameters:

vUeiList - the Vector to copy.

setUeiCollection

public void setUeiCollection(List<Uei> ueiList)

Deprecated.

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

Parameters:

ueiList - the Vector to set.

unmarshal

public static EventScript 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.scriptd.EventScript

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