org.opennms.netmgt.config.surveillanceViews

Class Rows

java.lang.Object

org.opennms.netmgt.config.surveillanceViews.Rows

All Implemented Interfaces:

Serializable

public class Rows
extends Object
implements Serializable

Class Rows.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Rows()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRowDef(int index, RowDef vRowDef)
void	addRowDef(RowDef vRowDef)
Enumeration<RowDef>	enumerateRowDef() Method enumerateRowDef.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
RowDef[]	getRowDef() Method getRowDef.Returns the contents of the collection in an Array.
RowDef	getRowDef(int index) Method getRowDef.
List<RowDef>	getRowDefCollection() Method getRowDefCollection.Returns a reference to '_rowDefList'.
int	getRowDefCount() Method getRowDefCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<RowDef>	iterateRowDef() Method iterateRowDef.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllRowDef()
boolean	removeRowDef(RowDef vRowDef) Method removeRowDef.
RowDef	removeRowDefAt(int index) Method removeRowDefAt.
void	setRowDef(int index, RowDef vRowDef)
void	setRowDef(List<RowDef> vRowDefList) Sets the value of '_rowDefList' by copying the given Vector.
void	setRowDef(RowDef[] vRowDefArray)
void	setRowDefCollection(List<RowDef> rowDefList) Deprecated.
static Rows	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

Rows

public Rows()

Method Detail

addRowDef

public void addRowDef(RowDef vRowDef)
               throws IndexOutOfBoundsException

Parameters:

vRowDef -

Throws:

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

addRowDef

public void addRowDef(int index,
             RowDef vRowDef)
               throws IndexOutOfBoundsException

Parameters:

index -

vRowDef -

Throws:

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

enumerateRowDef

public Enumeration<RowDef> enumerateRowDef()

Method enumerateRowDef.

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.

getRowDef

public RowDef getRowDef(int index)
                 throws IndexOutOfBoundsException

Method getRowDef.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.surveillanceViews.RowDef at the given index

Throws:

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

getRowDef

public RowDef[] getRowDef()

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

getRowDefCollection

public List<RowDef> getRowDefCollection()

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

Returns:

a reference to the Vector backing this class

getRowDefCount

public int getRowDefCount()

Method getRowDefCount.

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

iterateRowDef

public Iterator<RowDef> iterateRowDef()

Method iterateRowDef.

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

removeAllRowDef

public void removeAllRowDef()

removeRowDef

public boolean removeRowDef(RowDef vRowDef)

Method removeRowDef.

Parameters:

vRowDef -

Returns:

true if the object was removed from the collection.

removeRowDefAt

public RowDef removeRowDefAt(int index)

Method removeRowDefAt.

Parameters:

index -

Returns:

the element removed from the collection

setRowDef

public void setRowDef(int index,
             RowDef vRowDef)
               throws IndexOutOfBoundsException

Parameters:

index -

vRowDef -

Throws:

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

setRowDef

public void setRowDef(RowDef[] vRowDefArray)

Parameters:

vRowDefArray -

setRowDef

public void setRowDef(List<RowDef> vRowDefList)

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

Parameters:

vRowDefList - the Vector to copy.

setRowDefCollection

public void setRowDefCollection(List<RowDef> rowDefList)

Deprecated.

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

Parameters:

rowDefList - the Vector to set.

unmarshal

public static Rows 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.surveillanceViews.Rows

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