org.sourceforge.mbeanmonitoring.report.castor
Class List

java.lang.Object
  org.sourceforge.mbeanmonitoring.report.castor.List

All Implemented Interfaces:

java.io.Serializable

public class List
extends java.lang.Object
implements java.io.Serializable

Class List.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

List()

Method Summary

void	addElement(Element vElement)
void	addElement(int index, Element vElement)
java.util.Enumeration	enumerateElement() Method enumerateElement.
Element[]	getElement() Method getElement.Returns the contents of the collection in an Array.
Element	getElement(int index) Method getElement.
int	getElementCount() Method getElementCount.
java.lang.String	getName() Returns the value of field 'name'.
boolean	isValid() Method isValid.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllElement()
boolean	removeElement(Element vElement) Method removeElement.
Element	removeElementAt(int index) Method removeElementAt.
void	setElement(Element[] vElementArray)
void	setElement(int index, Element vElement)
void	setName(java.lang.String name) Sets the value of field 'name'.
static List	unmarshal(java.io.Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

List

public List()

Method Detail

addElement

public void addElement(Element vElement)
                throws java.lang.IndexOutOfBoundsException

Parameters:

vElement -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addElement

public void addElement(int index,
                       Element vElement)
                throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vElement -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateElement

public java.util.Enumeration enumerateElement()

Method enumerateElement.

Returns:

an Enumeration over all org.sourceforge.mbeanmonitoring.report.castor.Element element

getElement

public Element getElement(int index)
                   throws java.lang.IndexOutOfBoundsException

Method getElement.

Parameters:

index -

Returns:

the value of the org.sourceforge.mbeanmonitoring.report.castor.Element at the given index

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getElement

public Element[] getElement()

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

getElementCount

public int getElementCount()

Method getElementCount.

Returns:

the size of this collection

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(java.io.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(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

java.io.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

removeAllElement

public void removeAllElement()

removeElement

public boolean removeElement(Element vElement)

Method removeElement.

Parameters:

vElement -

Returns:

true if the object was removed from the collection.

removeElementAt

public Element removeElementAt(int index)

Method removeElementAt.

Parameters:

index -

Returns:

the element removed from the collection

setElement

public void setElement(int index,
                       Element vElement)
                throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vElement -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setElement

public void setElement(Element[] vElementArray)

Parameters:

vElementArray -

setName

public void setName(java.lang.String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

unmarshal

public static List unmarshal(java.io.Reader reader)
                      throws org.exolab.castor.xml.MarshalException,
                             org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.sourceforge.mbeanmonitoring.report.castor.List

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