org.sourceforge.mbeanmonitoring.report.castor
Class Attribute

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

All Implemented Interfaces:

java.io.Serializable

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

Class Attribute.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Attribute()

Method Summary

void	addList(int index, List vList)
void	addList(List vList)
void	addStat(int index, Stat vStat)
void	addStat(Stat vStat)
java.util.Enumeration	enumerateList() Method enumerateList.
java.util.Enumeration	enumerateStat() Method enumerateStat.
java.lang.String	getDescription() Returns the value of field 'description'.
List[]	getList() Method getList.Returns the contents of the collection in an Array.
List	getList(int index) Method getList.
int	getListCount() Method getListCount.
java.lang.String	getName() Returns the value of field 'name'.
Stat[]	getStat() Method getStat.Returns the contents of the collection in an Array.
Stat	getStat(int index) Method getStat.
int	getStatCount() Method getStatCount.
boolean	isValid() Method isValid.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllList()
void	removeAllStat()
boolean	removeList(List vList) Method removeList.
List	removeListAt(int index) Method removeListAt.
boolean	removeStat(Stat vStat) Method removeStat.
Stat	removeStatAt(int index) Method removeStatAt.
void	setDescription(java.lang.String description) Sets the value of field 'description'.
void	setList(int index, List vList)
void	setList(List[] vListArray)
void	setName(java.lang.String name) Sets the value of field 'name'.
void	setStat(int index, Stat vStat)
void	setStat(Stat[] vStatArray)
static Attribute	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

Attribute

public Attribute()

Method Detail

addList

public void addList(List vList)
             throws java.lang.IndexOutOfBoundsException

Parameters:

vList -

Throws:

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

addList

public void addList(int index,
                    List vList)
             throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vList -

Throws:

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

addStat

public void addStat(Stat vStat)
             throws java.lang.IndexOutOfBoundsException

Parameters:

vStat -

Throws:

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

addStat

public void addStat(int index,
                    Stat vStat)
             throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vStat -

Throws:

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

enumerateList

public java.util.Enumeration enumerateList()

Method enumerateList.

Returns:

an Enumeration over all org.sourceforge.mbeanmonitoring.report.castor.List elements

enumerateStat

public java.util.Enumeration enumerateStat()

Method enumerateStat.

Returns:

an Enumeration over all org.sourceforge.mbeanmonitoring.report.castor.Stat elements

getDescription

public java.lang.String getDescription()

Returns the value of field 'description'.

Returns:

the value of field 'Description'.

getList

public List getList(int index)
             throws java.lang.IndexOutOfBoundsException

Method getList.

Parameters:

index -

Returns:

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

Throws:

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

getList

public List[] getList()

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

getListCount

public int getListCount()

Method getListCount.

Returns:

the size of this collection

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getStat

public Stat getStat(int index)
             throws java.lang.IndexOutOfBoundsException

Method getStat.

Parameters:

index -

Returns:

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

Throws:

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

getStat

public Stat[] getStat()

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

getStatCount

public int getStatCount()

Method getStatCount.

Returns:

the size of this collection

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

removeAllList

public void removeAllList()

removeAllStat

public void removeAllStat()

removeList

public boolean removeList(List vList)

Method removeList.

Parameters:

vList -

Returns:

true if the object was removed from the collection.

removeListAt

public List removeListAt(int index)

Method removeListAt.

Parameters:

index -

Returns:

the element removed from the collection

removeStat

public boolean removeStat(Stat vStat)

Method removeStat.

Parameters:

vStat -

Returns:

true if the object was removed from the collection.

removeStatAt

public Stat removeStatAt(int index)

Method removeStatAt.

Parameters:

index -

Returns:

the element removed from the collection

setDescription

public void setDescription(java.lang.String description)

Sets the value of field 'description'.

Parameters:

description - the value of field 'description'.

setList

public void setList(int index,
                    List vList)
             throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vList -

Throws:

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

setList

public void setList(List[] vListArray)

Parameters:

vListArray -

setName

public void setName(java.lang.String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setStat

public void setStat(int index,
                    Stat vStat)
             throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vStat -

Throws:

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

setStat

public void setStat(Stat[] vStatArray)

Parameters:

vStatArray -

unmarshal

public static Attribute 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.Attribute

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