org.opennms.netmgt.config.ackd

Class Readers

java.lang.Object

org.opennms.netmgt.config.ackd.Readers

All Implemented Interfaces:

Serializable

public class Readers
extends Object
implements Serializable

Location for user to define readers and they're schedules.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Readers()
Readers(List<Reader> readers)
Readers(Reader reader)

Method Summary

Modifier and Type	Method and Description
void	addReader(int index, Reader vReader)
void	addReader(Reader vReader)
Enumeration<Reader>	enumerateReader() Method enumerateReader.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Reader[]	getReader() Method getReader.Returns the contents of the collection in an Array.
Reader	getReader(int index) Method getReader.
List<Reader>	getReaderCollection() Method getReaderCollection.Returns a reference to '_readerList'.
int	getReaderCount() Method getReaderCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
Iterator<Reader>	iterateReader() Method iterateReader.
void	removeAllReader()
boolean	removeReader(Reader vReader) Method removeReader.
Reader	removeReaderAt(int index) Method removeReaderAt.
void	setReader(int index, Reader vReader)
void	setReader(List<Reader> vReaderList) Sets the value of '_readerList' by copying the given Vector.
void	setReader(Reader[] vReaderArray)

Methods inherited from class java.lang.Object

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

Constructor Detail

Readers

public Readers()

Readers

public Readers(Reader reader)

Readers

public Readers(List<Reader> readers)

Method Detail

addReader

public void addReader(Reader vReader)
               throws IndexOutOfBoundsException

Parameters:

vReader -

Throws:

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

addReader

public void addReader(int index,
                      Reader vReader)
               throws IndexOutOfBoundsException

Parameters:

index -

vReader -

Throws:

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

enumerateReader

public Enumeration<Reader> enumerateReader()

Method enumerateReader.

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.

getReader

public Reader getReader(int index)
                 throws IndexOutOfBoundsException

Method getReader.

Parameters:

index -

Returns:

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

Throws:

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

getReader

public Reader[] getReader()

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

getReaderCollection

public List<Reader> getReaderCollection()

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

Returns:

a reference to the Vector backing this class

getReaderCount

public int getReaderCount()

Method getReaderCount.

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.

iterateReader

public Iterator<Reader> iterateReader()

Method iterateReader.

Returns:

an Iterator over all possible elements in this collection

removeAllReader

public void removeAllReader()

removeReader

public boolean removeReader(Reader vReader)

Method removeReader.

Parameters:

vReader -

Returns:

true if the object was removed from the collection.

removeReaderAt

public Reader removeReaderAt(int index)

Method removeReaderAt.

Parameters:

index -

Returns:

the element removed from the collection

setReader

public void setReader(int index,
                      Reader vReader)
               throws IndexOutOfBoundsException

Parameters:

index -

vReader -

Throws:

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

setReader

public void setReader(Reader[] vReaderArray)

Parameters:

vReaderArray -

setReader

public void setReader(List<Reader> vReaderList)

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

Parameters:

vReaderList - the Vector to copy.