org.opennms.netmgt.config.notifd

Class HandlerClass

java.lang.Object

org.opennms.netmgt.config.notifd.HandlerClass

All Implemented Interfaces:

Serializable

public class HandlerClass
extends Object
implements Serializable

Class HandlerClass.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HandlerClass()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInitParams(InitParams vInitParams)
void	addInitParams(int index, InitParams vInitParams)
Enumeration<InitParams>	enumerateInitParams() Method enumerateInitParams.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
InitParams[]	getInitParams() Method getInitParams.Returns the contents of the collection in an Array.
InitParams	getInitParams(int index) Method getInitParams.
List<InitParams>	getInitParamsCollection() Method getInitParamsCollection.Returns a reference to '_initParamsList'.
int	getInitParamsCount() Method getInitParamsCount.
String	getName() Returns the value of field 'name'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<InitParams>	iterateInitParams() Method iterateInitParams.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllInitParams()
boolean	removeInitParams(InitParams vInitParams) Method removeInitParams.
InitParams	removeInitParamsAt(int index) Method removeInitParamsAt.
void	setInitParams(InitParams[] vInitParamsArray)
void	setInitParams(int index, InitParams vInitParams)
void	setInitParams(List<InitParams> vInitParamsList) Sets the value of '_initParamsList' by copying the given Vector.
void	setInitParamsCollection(List<InitParams> initParamsList) Deprecated.
void	setName(String name) Sets the value of field 'name'.
static HandlerClass	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

HandlerClass

public HandlerClass()

Method Detail

addInitParams

public void addInitParams(InitParams vInitParams)
                   throws IndexOutOfBoundsException

Parameters:

vInitParams -

Throws:

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

addInitParams

public void addInitParams(int index,
                 InitParams vInitParams)
                   throws IndexOutOfBoundsException

Parameters:

index -

vInitParams -

Throws:

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

enumerateInitParams

public Enumeration<InitParams> enumerateInitParams()

Method enumerateInitParams.

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.

getInitParams

public InitParams getInitParams(int index)
                         throws IndexOutOfBoundsException

Method getInitParams.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.notifd.InitParams at the given inde

Throws:

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

getInitParams

public InitParams[] getInitParams()

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

getInitParamsCollection

public List<InitParams> getInitParamsCollection()

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

Returns:

a reference to the Vector backing this class

getInitParamsCount

public int getInitParamsCount()

Method getInitParamsCount.

Returns:

the size of this collection

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

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

iterateInitParams

public Iterator<InitParams> iterateInitParams()

Method iterateInitParams.

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

removeAllInitParams

public void removeAllInitParams()

removeInitParams

public boolean removeInitParams(InitParams vInitParams)

Method removeInitParams.

Parameters:

vInitParams -

Returns:

true if the object was removed from the collection.

removeInitParamsAt

public InitParams removeInitParamsAt(int index)

Method removeInitParamsAt.

Parameters:

index -

Returns:

the element removed from the collection

setInitParams

public void setInitParams(int index,
                 InitParams vInitParams)
                   throws IndexOutOfBoundsException

Parameters:

index -

vInitParams -

Throws:

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

setInitParams

public void setInitParams(InitParams[] vInitParamsArray)

Parameters:

vInitParamsArray -

setInitParams

public void setInitParams(List<InitParams> vInitParamsList)

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

Parameters:

vInitParamsList - the Vector to copy.

setInitParamsCollection

public void setInitParamsCollection(List<InitParams> initParamsList)

Deprecated.

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

Parameters:

initParamsList - the Vector to set.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

unmarshal

public static HandlerClass 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.notifd.HandlerClass

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