org.opennms.netmgt.config.pagesequence

Class PageSequence

java.lang.Object

org.opennms.netmgt.config.pagesequence.PageSequence

All Implemented Interfaces:

Serializable

public class PageSequence
extends Object
implements Serializable

Use this container to list the page in the order they are to be accessed for monitoring or (soon) datacollection.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PageSequence()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPage(int index, Page vPage)
void	addPage(Page vPage)
Enumeration<Page>	enumeratePage() Method enumeratePage.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Page[]	getPage() Method getPage.Returns the contents of the collection in an Array.
Page	getPage(int index) Method getPage.
List<Page>	getPageCollection() Method getPageCollection.Returns a reference to '_pageList'.
int	getPageCount() Method getPageCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Page>	iteratePage() Method iteratePage.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllPage()
boolean	removePage(Page vPage) Method removePage.
Page	removePageAt(int index) Method removePageAt.
void	setPage(int index, Page vPage)
void	setPage(List<Page> vPageList) Sets the value of '_pageList' by copying the given Vector.
void	setPage(Page[] vPageArray)
void	setPageCollection(List<Page> pageList) Deprecated.
static PageSequence	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

PageSequence

public PageSequence()

Method Detail

addPage

public void addPage(Page vPage)
             throws IndexOutOfBoundsException

Parameters:

vPage -

Throws:

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

addPage

public void addPage(int index,
           Page vPage)
             throws IndexOutOfBoundsException

Parameters:

index -

vPage -

Throws:

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

enumeratePage

public Enumeration<Page> enumeratePage()

Method enumeratePage.

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.

getPage

public Page getPage(int index)
             throws IndexOutOfBoundsException

Method getPage.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.pagesequence.Page at the given inde

Throws:

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

getPage

public Page[] getPage()

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

getPageCollection

public List<Page> getPageCollection()

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

Returns:

a reference to the Vector backing this class

getPageCount

public int getPageCount()

Method getPageCount.

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

iteratePage

public Iterator<Page> iteratePage()

Method iteratePage.

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

removeAllPage

public void removeAllPage()

removePage

public boolean removePage(Page vPage)

Method removePage.

Parameters:

vPage -

Returns:

true if the object was removed from the collection.

removePageAt

public Page removePageAt(int index)

Method removePageAt.

Parameters:

index -

Returns:

the element removed from the collection

setPage

public void setPage(int index,
           Page vPage)
             throws IndexOutOfBoundsException

Parameters:

index -

vPage -

Throws:

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

setPage

public void setPage(Page[] vPageArray)

Parameters:

vPageArray -

setPage

public void setPage(List<Page> vPageList)

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

Parameters:

vPageList - the Vector to copy.

setPageCollection

public void setPageCollection(List<Page> pageList)

Deprecated.

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

Parameters:

pageList - the Vector to set.

unmarshal

public static PageSequence 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.pagesequence.PageSequence

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