org.opennms.netmgt.config.collectd.jmx

Class CompAttrib

java.lang.Object

org.opennms.netmgt.config.collectd.jmx.CompAttrib

All Implemented Interfaces:

Serializable

public class CompAttrib
extends Object
implements Serializable

Class CompAttrib.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompAttrib()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompMember(CompMember vCompMember)
void	addCompMember(int index, CompMember vCompMember)
Enumeration<CompMember>	enumerateCompMember() Method enumerateCompMember.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getAlias() Returns the value of field 'alias'.
CompMember[]	getCompMember() Method getCompMember.Returns the contents of the collection in an Array.
CompMember	getCompMember(int index) Method getCompMember.
List<CompMember>	getCompMemberCollection() Method getCompMemberCollection.Returns a reference to '_compMemberList'.
int	getCompMemberCount() Method getCompMemberCount.
String	getName() Returns the value of field 'name'.
String	getType() Returns the value of field 'type'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Deprecated.
Iterator<CompMember>	iterateCompMember() Method iterateCompMember.
void	marshal(ContentHandler handler) Deprecated.
void	marshal(Writer out) Deprecated.
void	removeAllCompMember()
boolean	removeCompMember(CompMember vCompMember) Method removeCompMember.
CompMember	removeCompMemberAt(int index) Method removeCompMemberAt.
void	setAlias(String alias) Sets the value of field 'alias'.
void	setCompMember(CompMember[] vCompMemberArray)
void	setCompMember(int index, CompMember vCompMember)
void	setCompMember(List<CompMember> vCompMemberList) Sets the value of '_compMemberList' by copying the given Vector.
void	setCompMemberCollection(List<CompMember> compMemberList) Deprecated.
void	setName(String name) Sets the value of field 'name'.
void	setType(String type) Sets the value of field 'type'.
static CompAttrib	unmarshal(Reader reader) Deprecated.
void	validate() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompAttrib

public CompAttrib()

Method Detail

addCompMember

public void addCompMember(CompMember vCompMember)
                   throws IndexOutOfBoundsException

Parameters:

vCompMember -

Throws:

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

addCompMember

public void addCompMember(int index,
                 CompMember vCompMember)
                   throws IndexOutOfBoundsException

Parameters:

index -

vCompMember -

Throws:

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

enumerateCompMember

public Enumeration<CompMember> enumerateCompMember()

Method enumerateCompMember.

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.

getAlias

public String getAlias()

Returns the value of field 'alias'.

Returns:

the value of field 'Alias'.

getCompMember

public CompMember getCompMember(int index)
                         throws IndexOutOfBoundsException

Method getCompMember.

Parameters:

index -

Returns:

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

Throws:

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

getCompMember

public CompMember[] getCompMember()

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

getCompMemberCollection

public List<CompMember> getCompMemberCollection()

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

Returns:

a reference to the Vector backing this class

getCompMemberCount

public int getCompMemberCount()

Method getCompMemberCount.

Returns:

the size of this collection

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getType

public String getType()

Returns the value of field 'type'.

Returns:

the value of field 'Type'.

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

@Deprecated
public boolean isValid()

Deprecated.

Method isValid.

Returns:

true if this object is valid according to the schema

iterateCompMember

public Iterator<CompMember> iterateCompMember()

Method iterateCompMember.

Returns:

an Iterator over all possible elements in this collection

marshal

@Deprecated
public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Deprecated.

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

@Deprecated
public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Deprecated.

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

removeAllCompMember

public void removeAllCompMember()

removeCompMember

public boolean removeCompMember(CompMember vCompMember)

Method removeCompMember.

Parameters:

vCompMember -

Returns:

true if the object was removed from the collection.

removeCompMemberAt

public CompMember removeCompMemberAt(int index)

Method removeCompMemberAt.

Parameters:

index -

Returns:

the element removed from the collection

setAlias

public void setAlias(String alias)

Sets the value of field 'alias'.

Parameters:

alias - the value of field 'alias'.

setCompMember

public void setCompMember(int index,
                 CompMember vCompMember)
                   throws IndexOutOfBoundsException

Parameters:

index -

vCompMember -

Throws:

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

setCompMember

public void setCompMember(CompMember[] vCompMemberArray)

Parameters:

vCompMemberArray -

setCompMember

public void setCompMember(List<CompMember> vCompMemberList)

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

Parameters:

vCompMemberList - the Vector to copy.

setCompMemberCollection

public void setCompMemberCollection(List<CompMember> compMemberList)

Deprecated.

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

Parameters:

compMemberList - the Vector to set.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setType

public void setType(String type)

Sets the value of field 'type'.

Parameters:

type - the value of field 'type'.

unmarshal

@Deprecated
public static CompAttrib unmarshal(Reader reader)
                            throws org.exolab.castor.xml.MarshalException,
                                   org.exolab.castor.xml.ValidationException

Deprecated.

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.collectd.jmx.CompAttrib

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

@Deprecated
public void validate()
              throws org.exolab.castor.xml.ValidationException

Deprecated.

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema