org.opennms.netmgt.config.ackd
Class Reader

java.lang.Object
  org.opennms.netmgt.config.ackd.Reader

All Implemented Interfaces:

Serializable

public class Reader
extends Object
implements Serializable

Class Reader.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Reader()

Method Summary

void	addParameter(int index, Parameter vParameter)
void	addParameter(Parameter vParameter)
void	deleteEnabled()
Enumeration<Parameter>	enumerateParameter() Method enumerateParameter.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
boolean	getEnabled() Returns the value of field 'enabled'.
Parameter[]	getParameter() Method getParameter.Returns the contents of the collection in an Array.
Parameter	getParameter(int index) Method getParameter.
List<Parameter>	getParameterCollection() Method getParameterCollection.Returns a reference to '_parameterList'.
int	getParameterCount() Method getParameterCount.
String	getReaderName() Returns the value of field 'readerName'.
ReaderSchedule	getReaderSchedule() Returns the value of field 'readerSchedule'.
boolean	hasEnabled() Method hasEnabled.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isEnabled() Returns the value of field 'enabled'.
boolean	isValid() Method isValid.
Iterator<Parameter>	iterateParameter() Method iterateParameter.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllParameter()
boolean	removeParameter(Parameter vParameter) Method removeParameter.
Parameter	removeParameterAt(int index) Method removeParameterAt.
void	setEnabled(boolean enabled) Sets the value of field 'enabled'.
void	setParameter(int index, Parameter vParameter)
void	setParameter(List<Parameter> vParameterList) Sets the value of '_parameterList' by copying the given Vector.
void	setParameter(Parameter[] vParameterArray)
void	setParameterCollection(List<Parameter> parameterList) Deprecated.
void	setReaderName(String readerName) Sets the value of field 'readerName'.
void	setReaderSchedule(ReaderSchedule readerSchedule) Sets the value of field 'readerSchedule'.
static Reader	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

Reader

public Reader()

Method Detail

addParameter

public void addParameter(Parameter vParameter)
                  throws IndexOutOfBoundsException

Parameters:

vParameter -

Throws:

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

addParameter

public void addParameter(int index,
                         Parameter vParameter)
                  throws IndexOutOfBoundsException

Parameters:

index -

vParameter -

Throws:

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

deleteEnabled

public void deleteEnabled()

enumerateParameter

public Enumeration<Parameter> enumerateParameter()

Method enumerateParameter.

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.

getEnabled

public boolean getEnabled()

Returns the value of field 'enabled'.

Returns:

the value of field 'Enabled'.

getParameter

public Parameter getParameter(int index)
                       throws IndexOutOfBoundsException

Method getParameter.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.ackd.Parameter at the given index

Throws:

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

getParameter

public Parameter[] getParameter()

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

getParameterCollection

public List<Parameter> getParameterCollection()

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

Returns:

a reference to the Vector backing this class

getParameterCount

public int getParameterCount()

Method getParameterCount.

Returns:

the size of this collection

getReaderName

public String getReaderName()

Returns the value of field 'readerName'. The field 'readerName' has the following description: The reader name is the value returned by the getName() method required by the AckReader interface. Readers are currently wired in using Spring.

Returns:

the value of field 'ReaderName'.

getReaderSchedule

public ReaderSchedule getReaderSchedule()

Returns the value of field 'readerSchedule'. The field 'readerSchedule' has the following description: A very basic configuration for defining simple input to a schedule (java.lang.concurrent)

Returns:

the value of field 'ReaderSchedule'.

hasEnabled

public boolean hasEnabled()

Method hasEnabled.

Returns:

true if at least one Enabled has been added

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.

isEnabled

public boolean isEnabled()

Returns the value of field 'enabled'.

Returns:

the value of field 'Enabled'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateParameter

public Iterator<Parameter> iterateParameter()

Method iterateParameter.

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

removeAllParameter

public void removeAllParameter()

removeParameter

public boolean removeParameter(Parameter vParameter)

Method removeParameter.

Parameters:

vParameter -

Returns:

true if the object was removed from the collection.

removeParameterAt

public Parameter removeParameterAt(int index)

Method removeParameterAt.

Parameters:

index -

Returns:

the element removed from the collection

setEnabled

public void setEnabled(boolean enabled)

Sets the value of field 'enabled'.

Parameters:

enabled - the value of field 'enabled'.

setParameter

public void setParameter(int index,
                         Parameter vParameter)
                  throws IndexOutOfBoundsException

Parameters:

index -

vParameter -

Throws:

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

setParameter

public void setParameter(Parameter[] vParameterArray)

Parameters:

vParameterArray -

setParameter

public void setParameter(List<Parameter> vParameterList)

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

Parameters:

vParameterList - the Vector to copy.

setParameterCollection

public void setParameterCollection(List<Parameter> parameterList)

Deprecated.

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

Parameters:

parameterList - the Vector to set.

setReaderName

public void setReaderName(String readerName)

Sets the value of field 'readerName'. The field 'readerName' has the following description: The reader name is the value returned by the getName() method required by the AckReader interface. Readers are currently wired in using Spring.

Parameters:

readerName - the value of field 'readerName'.

setReaderSchedule

public void setReaderSchedule(ReaderSchedule readerSchedule)

Sets the value of field 'readerSchedule'. The field 'readerSchedule' has the following description: A very basic configuration for defining simple input to a schedule (java.lang.concurrent)

Parameters:

readerSchedule - the value of field 'readerSchedule'.

unmarshal

public static Reader 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.ackd.Reader

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