org.opennms.netmgt.config.collectd
Class Mbean

java.lang.Object
  org.opennms.netmgt.config.collectd.Mbean

All Implemented Interfaces:

Serializable

public class Mbean
extends Object
implements Serializable

Class Mbean.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Mbean()

Method Summary

void	addAttrib(Attrib vAttrib)
void	addAttrib(int index, Attrib vAttrib)
void	addCompAttrib(CompAttrib vCompAttrib)
void	addCompAttrib(int index, CompAttrib vCompAttrib)
void	addIncludeMbean(int index, String vIncludeMbean)
void	addIncludeMbean(String vIncludeMbean)
Enumeration<Attrib>	enumerateAttrib() Method enumerateAttrib.
Enumeration<CompAttrib>	enumerateCompAttrib() Method enumerateCompAttrib.
Enumeration<String>	enumerateIncludeMbean() Method enumerateIncludeMbean.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Attrib[]	getAttrib() Method getAttrib.Returns the contents of the collection in an Array.
Attrib	getAttrib(int index) Method getAttrib.
List<Attrib>	getAttribCollection() Method getAttribCollection.Returns a reference to '_attribList'.
int	getAttribCount() Method getAttribCount.
CompAttrib[]	getCompAttrib() Method getCompAttrib.Returns the contents of the collection in an Array.
CompAttrib	getCompAttrib(int index) Method getCompAttrib.
List<CompAttrib>	getCompAttribCollection() Method getCompAttribCollection.Returns a reference to '_compAttribList'.
int	getCompAttribCount() Method getCompAttribCount.
String	getExclude() Returns the value of field 'exclude'.
String[]	getIncludeMbean() Method getIncludeMbean.Returns the contents of the collection in an Array.
String	getIncludeMbean(int index) Method getIncludeMbean.
List<String>	getIncludeMbeanCollection() Method getIncludeMbeanCollection.Returns a reference to '_includeMbeanList'.
int	getIncludeMbeanCount() Method getIncludeMbeanCount.
String	getKeyAlias() Returns the value of field 'keyAlias'.
String	getKeyfield() Returns the value of field 'keyfield'.
String	getName() Returns the value of field 'name'.
String	getObjectname() Returns the value of field 'objectname'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Attrib>	iterateAttrib() Method iterateAttrib.
Iterator<CompAttrib>	iterateCompAttrib() Method iterateCompAttrib.
Iterator<String>	iterateIncludeMbean() Method iterateIncludeMbean.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllAttrib()
void	removeAllCompAttrib()
void	removeAllIncludeMbean()
boolean	removeAttrib(Attrib vAttrib) Method removeAttrib.
Attrib	removeAttribAt(int index) Method removeAttribAt.
boolean	removeCompAttrib(CompAttrib vCompAttrib) Method removeCompAttrib.
CompAttrib	removeCompAttribAt(int index) Method removeCompAttribAt.
boolean	removeIncludeMbean(String vIncludeMbean) Method removeIncludeMbean.
String	removeIncludeMbeanAt(int index) Method removeIncludeMbeanAt.
void	setAttrib(Attrib[] vAttribArray)
void	setAttrib(int index, Attrib vAttrib)
void	setAttrib(List<Attrib> vAttribList) Sets the value of '_attribList' by copying the given Vector.
void	setAttribCollection(List<Attrib> attribList) Deprecated.
void	setCompAttrib(CompAttrib[] vCompAttribArray)
void	setCompAttrib(int index, CompAttrib vCompAttrib)
void	setCompAttrib(List<CompAttrib> vCompAttribList) Sets the value of '_compAttribList' by copying the given Vector.
void	setCompAttribCollection(List<CompAttrib> compAttribList) Deprecated.
void	setExclude(String exclude) Sets the value of field 'exclude'.
void	setIncludeMbean(int index, String vIncludeMbean)
void	setIncludeMbean(List<String> vIncludeMbeanList) Sets the value of '_includeMbeanList' by copying the given Vector.
void	setIncludeMbean(String[] vIncludeMbeanArray)
void	setIncludeMbeanCollection(List<String> includeMbeanList) Deprecated.
void	setKeyAlias(String keyAlias) Sets the value of field 'keyAlias'.
void	setKeyfield(String keyfield) Sets the value of field 'keyfield'.
void	setName(String name) Sets the value of field 'name'.
void	setObjectname(String objectname) Sets the value of field 'objectname'.
static Mbean	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

Mbean

public Mbean()

Method Detail

addAttrib

public void addAttrib(Attrib vAttrib)
               throws IndexOutOfBoundsException

Parameters:

vAttrib -

Throws:

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

addAttrib

public void addAttrib(int index,
                      Attrib vAttrib)
               throws IndexOutOfBoundsException

Parameters:

index -

vAttrib -

Throws:

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

addCompAttrib

public void addCompAttrib(CompAttrib vCompAttrib)
                   throws IndexOutOfBoundsException

Parameters:

vCompAttrib -

Throws:

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

addCompAttrib

public void addCompAttrib(int index,
                          CompAttrib vCompAttrib)
                   throws IndexOutOfBoundsException

Parameters:

index -

vCompAttrib -

Throws:

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

addIncludeMbean

public void addIncludeMbean(String vIncludeMbean)
                     throws IndexOutOfBoundsException

Parameters:

vIncludeMbean -

Throws:

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

addIncludeMbean

public void addIncludeMbean(int index,
                            String vIncludeMbean)
                     throws IndexOutOfBoundsException

Parameters:

index -

vIncludeMbean -

Throws:

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

enumerateAttrib

public Enumeration<Attrib> enumerateAttrib()

Method enumerateAttrib.

Returns:

an Enumeration over all possible elements of this collection

enumerateCompAttrib

public Enumeration<CompAttrib> enumerateCompAttrib()

Method enumerateCompAttrib.

Returns:

an Enumeration over all possible elements of this collection

enumerateIncludeMbean

public Enumeration<String> enumerateIncludeMbean()

Method enumerateIncludeMbean.

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.

getAttrib

public Attrib getAttrib(int index)
                 throws IndexOutOfBoundsException

Method getAttrib.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.collectd.Attrib at the given index

Throws:

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

getAttrib

public Attrib[] getAttrib()

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

getAttribCollection

public List<Attrib> getAttribCollection()

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

Returns:

a reference to the Vector backing this class

getAttribCount

public int getAttribCount()

Method getAttribCount.

Returns:

the size of this collection

getCompAttrib

public CompAttrib getCompAttrib(int index)
                         throws IndexOutOfBoundsException

Method getCompAttrib.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.collectd.CompAttrib at the given index

Throws:

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

getCompAttrib

public CompAttrib[] getCompAttrib()

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

getCompAttribCollection

public List<CompAttrib> getCompAttribCollection()

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

Returns:

a reference to the Vector backing this class

getCompAttribCount

public int getCompAttribCount()

Method getCompAttribCount.

Returns:

the size of this collection

getExclude

public String getExclude()

Returns the value of field 'exclude'.

Returns:

the value of field 'Exclude'.

getIncludeMbean

public String getIncludeMbean(int index)
                       throws IndexOutOfBoundsException

Method getIncludeMbean.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

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

getIncludeMbean

public String[] getIncludeMbean()

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

getIncludeMbeanCollection

public List<String> getIncludeMbeanCollection()

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

Returns:

a reference to the Vector backing this class

getIncludeMbeanCount

public int getIncludeMbeanCount()

Method getIncludeMbeanCount.

Returns:

the size of this collection

getKeyAlias

public String getKeyAlias()

Returns the value of field 'keyAlias'.

Returns:

the value of field 'KeyAlias'.

getKeyfield

public String getKeyfield()

Returns the value of field 'keyfield'.

Returns:

the value of field 'Keyfield'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getObjectname

public String getObjectname()

Returns the value of field 'objectname'.

Returns:

the value of field 'Objectname'.

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

iterateAttrib

public Iterator<Attrib> iterateAttrib()

Method iterateAttrib.

Returns:

an Iterator over all possible elements in this collection

iterateCompAttrib

public Iterator<CompAttrib> iterateCompAttrib()

Method iterateCompAttrib.

Returns:

an Iterator over all possible elements in this collection

iterateIncludeMbean

public Iterator<String> iterateIncludeMbean()

Method iterateIncludeMbean.

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

removeAllAttrib

public void removeAllAttrib()

removeAllCompAttrib

public void removeAllCompAttrib()

removeAllIncludeMbean

public void removeAllIncludeMbean()

removeAttrib

public boolean removeAttrib(Attrib vAttrib)

Method removeAttrib.

Parameters:

vAttrib -

Returns:

true if the object was removed from the collection.

removeAttribAt

public Attrib removeAttribAt(int index)

Method removeAttribAt.

Parameters:

index -

Returns:

the element removed from the collection

removeCompAttrib

public boolean removeCompAttrib(CompAttrib vCompAttrib)

Method removeCompAttrib.

Parameters:

vCompAttrib -

Returns:

true if the object was removed from the collection.

removeCompAttribAt

public CompAttrib removeCompAttribAt(int index)

Method removeCompAttribAt.

Parameters:

index -

Returns:

the element removed from the collection

removeIncludeMbean

public boolean removeIncludeMbean(String vIncludeMbean)

Method removeIncludeMbean.

Parameters:

vIncludeMbean -

Returns:

true if the object was removed from the collection.

removeIncludeMbeanAt

public String removeIncludeMbeanAt(int index)

Method removeIncludeMbeanAt.

Parameters:

index -

Returns:

the element removed from the collection

setAttrib

public void setAttrib(int index,
                      Attrib vAttrib)
               throws IndexOutOfBoundsException

Parameters:

index -

vAttrib -

Throws:

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

setAttrib

public void setAttrib(Attrib[] vAttribArray)

Parameters:

vAttribArray -

setAttrib

public void setAttrib(List<Attrib> vAttribList)

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

Parameters:

vAttribList - the Vector to copy.

setAttribCollection

public void setAttribCollection(List<Attrib> attribList)

Deprecated.

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

Parameters:

attribList - the Vector to set.

setCompAttrib

public void setCompAttrib(int index,
                          CompAttrib vCompAttrib)
                   throws IndexOutOfBoundsException

Parameters:

index -

vCompAttrib -

Throws:

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

setCompAttrib

public void setCompAttrib(CompAttrib[] vCompAttribArray)

Parameters:

vCompAttribArray -

setCompAttrib

public void setCompAttrib(List<CompAttrib> vCompAttribList)

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

Parameters:

vCompAttribList - the Vector to copy.

setCompAttribCollection

public void setCompAttribCollection(List<CompAttrib> compAttribList)

Deprecated.

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

Parameters:

compAttribList - the Vector to set.

setExclude

public void setExclude(String exclude)

Sets the value of field 'exclude'.

Parameters:

exclude - the value of field 'exclude'.

setIncludeMbean

public void setIncludeMbean(int index,
                            String vIncludeMbean)
                     throws IndexOutOfBoundsException

Parameters:

index -

vIncludeMbean -

Throws:

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

setIncludeMbean

public void setIncludeMbean(String[] vIncludeMbeanArray)

Parameters:

vIncludeMbeanArray -

setIncludeMbean

public void setIncludeMbean(List<String> vIncludeMbeanList)

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

Parameters:

vIncludeMbeanList - the Vector to copy.

setIncludeMbeanCollection

public void setIncludeMbeanCollection(List<String> includeMbeanList)

Deprecated.

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

Parameters:

includeMbeanList - the Vector to set.

setKeyAlias

public void setKeyAlias(String keyAlias)

Sets the value of field 'keyAlias'.

Parameters:

keyAlias - the value of field 'keyAlias'.

setKeyfield

public void setKeyfield(String keyfield)

Sets the value of field 'keyfield'.

Parameters:

keyfield - the value of field 'keyfield'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setObjectname

public void setObjectname(String objectname)

Sets the value of field 'objectname'.

Parameters:

objectname - the value of field 'objectname'.

unmarshal

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