org.opennms.netmgt.xml.eventconf

Class Varbindsdecode

java.lang.Object

org.opennms.netmgt.xml.eventconf.Varbindsdecode

All Implemented Interfaces:

Serializable

public class Varbindsdecode
extends Object
implements Serializable

This element is used for converting event varbind value in static decoded string.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Varbindsdecode()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDecode(Decode vDecode)
void	addDecode(int index, Decode vDecode)
Enumeration<Decode>	enumerateDecode() Method enumerateDecode.
boolean	equals(Object obj) Overrides the Object.equals method.
Decode[]	getDecode() Method getDecode.Returns the contents of the collection in an Array.
Decode	getDecode(int index) Method getDecode.
List<Decode>	getDecodeCollection() Method getDecodeCollection.Returns a reference to '_decodeList'.
int	getDecodeCount() Method getDecodeCount.
String	getParmid() Returns the value of field 'parmid'.
int	hashCode() Overrides the Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Decode>	iterateDecode() Method iterateDecode.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllDecode()
boolean	removeDecode(Decode vDecode) Method removeDecode.
Decode	removeDecodeAt(int index) Method removeDecodeAt.
void	setDecode(Decode[] vDecodeArray)
void	setDecode(int index, Decode vDecode)
void	setDecode(List<Decode> vDecodeList) Sets the value of '_decodeList' by copying the given Vector.
void	setDecodeCollection(List<Decode> decodeList) Deprecated.
void	setParmid(String parmid) Sets the value of field 'parmid'.
static Varbindsdecode	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

Varbindsdecode

public Varbindsdecode()

Method Detail

addDecode

public void addDecode(Decode vDecode)
               throws IndexOutOfBoundsException

Parameters:

vDecode -

Throws:

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

addDecode

public void addDecode(int index,
             Decode vDecode)
               throws IndexOutOfBoundsException

Parameters:

index -

vDecode -

Throws:

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

enumerateDecode

public Enumeration<Decode> enumerateDecode()

Method enumerateDecode.

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.

getDecode

public Decode getDecode(int index)
                 throws IndexOutOfBoundsException

Method getDecode.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.xml.eventconf.Decode at the given index

Throws:

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

getDecode

public Decode[] getDecode()

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

getDecodeCollection

public List<Decode> getDecodeCollection()

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

Returns:

a reference to the Vector backing this class

getDecodeCount

public int getDecodeCount()

Method getDecodeCount.

Returns:

the size of this collection

getParmid

public String getParmid()

Returns the value of field 'parmid'. The field 'parmid' has the following description: The identifier of the parameters to be decoded

Returns:

the value of field 'Parmid'.

hashCode

public int hashCode()

Overrides the 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

iterateDecode

public Iterator<Decode> iterateDecode()

Method iterateDecode.

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

removeAllDecode

public void removeAllDecode()

removeDecode

public boolean removeDecode(Decode vDecode)

Method removeDecode.

Parameters:

vDecode -

Returns:

true if the object was removed from the collection.

removeDecodeAt

public Decode removeDecodeAt(int index)

Method removeDecodeAt.

Parameters:

index -

Returns:

the element removed from the collection

setDecode

public void setDecode(int index,
             Decode vDecode)
               throws IndexOutOfBoundsException

Parameters:

index -

vDecode -

Throws:

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

setDecode

public void setDecode(Decode[] vDecodeArray)

Parameters:

vDecodeArray -

setDecode

public void setDecode(List<Decode> vDecodeList)

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

Parameters:

vDecodeList - the Vector to copy.

setDecodeCollection

public void setDecodeCollection(List<Decode> decodeList)

Deprecated.

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

Parameters:

decodeList - the Vector to set.

setParmid

public void setParmid(String parmid)

Sets the value of field 'parmid'. The field 'parmid' has the following description: The identifier of the parameters to be decoded

Parameters:

parmid - the value of field 'parmid'.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.xml.eventconf.Varbindsdecode

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