org.sourceforge.mbeanmonitoring.report.castor
Class Mbean

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

All Implemented Interfaces:

java.io.Serializable

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

Class Mbean.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Mbean()

Method Summary

void	addAttribute(Attribute vAttribute)
void	addAttribute(int index, Attribute vAttribute)
java.util.Enumeration	enumerateAttribute() Method enumerateAttribute.
Attribute[]	getAttribute() Method getAttribute.Returns the contents of the collection in an Array.
Attribute	getAttribute(int index) Method getAttribute.
int	getAttributeCount() Method getAttributeCount.
MbeanDomainType	getDomain() Returns the value of field 'domain'.
java.lang.String	getFilename() Returns the value of field 'filename'.
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	removeAllAttribute()
boolean	removeAttribute(Attribute vAttribute) Method removeAttribute.
Attribute	removeAttributeAt(int index) Method removeAttributeAt.
void	setAttribute(Attribute[] vAttributeArray)
void	setAttribute(int index, Attribute vAttribute)
void	setDomain(MbeanDomainType domain) Sets the value of field 'domain'.
void	setFilename(java.lang.String filename) Sets the value of field 'filename'.
void	setName(java.lang.String name) Sets the value of field 'name'.
static Mbean	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

Mbean

public Mbean()

Method Detail

addAttribute

public void addAttribute(Attribute vAttribute)
                  throws java.lang.IndexOutOfBoundsException

Parameters:

vAttribute -

Throws:

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

addAttribute

public void addAttribute(int index,
                         Attribute vAttribute)
                  throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vAttribute -

Throws:

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

enumerateAttribute

public java.util.Enumeration enumerateAttribute()

Method enumerateAttribute.

Returns:

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

getAttribute

public Attribute getAttribute(int index)
                       throws java.lang.IndexOutOfBoundsException

Method getAttribute.

Parameters:

index -

Returns:

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

Throws:

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

getAttribute

public Attribute[] getAttribute()

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

getAttributeCount

public int getAttributeCount()

Method getAttributeCount.

Returns:

the size of this collection

getDomain

public MbeanDomainType getDomain()

Returns the value of field 'domain'.

Returns:

the value of field 'Domain'.

getFilename

public java.lang.String getFilename()

Returns the value of field 'filename'.

Returns:

the value of field 'Filename'.

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

removeAllAttribute

public void removeAllAttribute()

removeAttribute

public boolean removeAttribute(Attribute vAttribute)

Method removeAttribute.

Parameters:

vAttribute -

Returns:

true if the object was removed from the collection.

removeAttributeAt

public Attribute removeAttributeAt(int index)

Method removeAttributeAt.

Parameters:

index -

Returns:

the element removed from the collection

setAttribute

public void setAttribute(int index,
                         Attribute vAttribute)
                  throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vAttribute -

Throws:

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

setAttribute

public void setAttribute(Attribute[] vAttributeArray)

Parameters:

vAttributeArray -

setDomain

public void setDomain(MbeanDomainType domain)

Sets the value of field 'domain'.

Parameters:

domain - the value of field 'domain'.

setFilename

public void setFilename(java.lang.String filename)

Sets the value of field 'filename'.

Parameters:

filename - the value of field 'filename'.

setName

public void setName(java.lang.String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

unmarshal

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

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