org.opennms.netmgt.config.xmpDataCollection
Class Group

java.lang.Object
  org.opennms.netmgt.config.xmpDataCollection.Group

All Implemented Interfaces:

Serializable

public class Group
extends Object
implements Serializable

a MIB object group

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Group()

Method Summary

void	addIncludeGroup(int index, String vIncludeGroup)
void	addIncludeGroup(String vIncludeGroup)
void	addMibObj(int index, MibObj vMibObj)
void	addMibObj(MibObj vMibObj)
Enumeration<String>	enumerateIncludeGroup() Method enumerateIncludeGroup.
Enumeration<MibObj>	enumerateMibObj() Method enumerateMibObj.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String[]	getIncludeGroup() Method getIncludeGroup.Returns the contents of the collection in an Array.
String	getIncludeGroup(int index) Method getIncludeGroup.
List<String>	getIncludeGroupCollection() Method getIncludeGroupCollection.Returns a reference to '_includeGroupList'.
int	getIncludeGroupCount() Method getIncludeGroupCount.
MibObj[]	getMibObj() Method getMibObj.Returns the contents of the collection in an Array.
MibObj	getMibObj(int index) Method getMibObj.
List<MibObj>	getMibObjCollection() Method getMibObjCollection.Returns a reference to '_mibObjList'.
int	getMibObjCount() Method getMibObjCount.
String	getName() Returns the value of field 'name'.
String	getResourceType() Returns the value of field 'resourceType'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<String>	iterateIncludeGroup() Method iterateIncludeGroup.
Iterator<MibObj>	iterateMibObj() Method iterateMibObj.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllIncludeGroup()
void	removeAllMibObj()
boolean	removeIncludeGroup(String vIncludeGroup) Method removeIncludeGroup.
String	removeIncludeGroupAt(int index) Method removeIncludeGroupAt.
boolean	removeMibObj(MibObj vMibObj) Method removeMibObj.
MibObj	removeMibObjAt(int index) Method removeMibObjAt.
void	setIncludeGroup(int index, String vIncludeGroup)
void	setIncludeGroup(List<String> vIncludeGroupList) Sets the value of '_includeGroupList' by copying the given Vector.
void	setIncludeGroup(String[] vIncludeGroupArray)
void	setIncludeGroupCollection(List<String> includeGroupList) Deprecated.
void	setMibObj(int index, MibObj vMibObj)
void	setMibObj(List<MibObj> vMibObjList) Sets the value of '_mibObjList' by copying the given Vector.
void	setMibObj(MibObj[] vMibObjArray)
void	setMibObjCollection(List<MibObj> mibObjList) Deprecated.
void	setName(String name) Sets the value of field 'name'.
void	setResourceType(String resourceType) Sets the value of field 'resourceType'.
static Group	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

Group

public Group()

Method Detail

addIncludeGroup

public void addIncludeGroup(String vIncludeGroup)
                     throws IndexOutOfBoundsException

Parameters:

vIncludeGroup -

Throws:

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

addIncludeGroup

public void addIncludeGroup(int index,
                            String vIncludeGroup)
                     throws IndexOutOfBoundsException

Parameters:

index -

vIncludeGroup -

Throws:

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

addMibObj

public void addMibObj(MibObj vMibObj)
               throws IndexOutOfBoundsException

Parameters:

vMibObj -

Throws:

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

addMibObj

public void addMibObj(int index,
                      MibObj vMibObj)
               throws IndexOutOfBoundsException

Parameters:

index -

vMibObj -

Throws:

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

enumerateIncludeGroup

public Enumeration<String> enumerateIncludeGroup()

Method enumerateIncludeGroup.

Returns:

an Enumeration over all possible elements of this collection

enumerateMibObj

public Enumeration<MibObj> enumerateMibObj()

Method enumerateMibObj.

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.

getIncludeGroup

public String getIncludeGroup(int index)
                       throws IndexOutOfBoundsException

Method getIncludeGroup.

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

getIncludeGroup

public String[] getIncludeGroup()

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

getIncludeGroupCollection

public List<String> getIncludeGroupCollection()

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

Returns:

a reference to the Vector backing this class

getIncludeGroupCount

public int getIncludeGroupCount()

Method getIncludeGroupCount.

Returns:

the size of this collection

getMibObj

public MibObj getMibObj(int index)
                 throws IndexOutOfBoundsException

Method getMibObj.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.xmpDataCollection.MibObj at the given index

Throws:

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

getMibObj

public MibObj[] getMibObj()

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

getMibObjCollection

public List<MibObj> getMibObjCollection()

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

Returns:

a reference to the Vector backing this class

getMibObjCount

public int getMibObjCount()

Method getMibObjCount.

Returns:

the size of this collection

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: group name

Returns:

the value of field 'Name'.

getResourceType

public String getResourceType()

Returns the value of field 'resourceType'. The field 'resourceType' has the following description: Name of resource or null if scalars. Resource type matches declaration in datacollection-config.xml for presentation in Web UI and in RRD storage. Each table, that is collected, should generally be given their own resource type. MIB2 tables, however, need not be given a separate resourceType as they are handled out-of-box by ONMS.

Returns:

the value of field 'ResourceType'.

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

iterateIncludeGroup

public Iterator<String> iterateIncludeGroup()

Method iterateIncludeGroup.

Returns:

an Iterator over all possible elements in this collection

iterateMibObj

public Iterator<MibObj> iterateMibObj()

Method iterateMibObj.

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

removeAllIncludeGroup

public void removeAllIncludeGroup()

removeAllMibObj

public void removeAllMibObj()

removeIncludeGroup

public boolean removeIncludeGroup(String vIncludeGroup)

Method removeIncludeGroup.

Parameters:

vIncludeGroup -

Returns:

true if the object was removed from the collection.

removeIncludeGroupAt

public String removeIncludeGroupAt(int index)

Method removeIncludeGroupAt.

Parameters:

index -

Returns:

the element removed from the collection

removeMibObj

public boolean removeMibObj(MibObj vMibObj)

Method removeMibObj.

Parameters:

vMibObj -

Returns:

true if the object was removed from the collection.

removeMibObjAt

public MibObj removeMibObjAt(int index)

Method removeMibObjAt.

Parameters:

index -

Returns:

the element removed from the collection

setIncludeGroup

public void setIncludeGroup(int index,
                            String vIncludeGroup)
                     throws IndexOutOfBoundsException

Parameters:

index -

vIncludeGroup -

Throws:

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

setIncludeGroup

public void setIncludeGroup(String[] vIncludeGroupArray)

Parameters:

vIncludeGroupArray -

setIncludeGroup

public void setIncludeGroup(List<String> vIncludeGroupList)

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

Parameters:

vIncludeGroupList - the Vector to copy.

setIncludeGroupCollection

public void setIncludeGroupCollection(List<String> includeGroupList)

Deprecated.

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

Parameters:

includeGroupList - the Vector to set.

setMibObj

public void setMibObj(int index,
                      MibObj vMibObj)
               throws IndexOutOfBoundsException

Parameters:

index -

vMibObj -

Throws:

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

setMibObj

public void setMibObj(MibObj[] vMibObjArray)

Parameters:

vMibObjArray -

setMibObj

public void setMibObj(List<MibObj> vMibObjList)

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

Parameters:

vMibObjList - the Vector to copy.

setMibObjCollection

public void setMibObjCollection(List<MibObj> mibObjList)

Deprecated.

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

Parameters:

mibObjList - the Vector to set.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: group name

Parameters:

name - the value of field 'name'.

setResourceType

public void setResourceType(String resourceType)

Sets the value of field 'resourceType'. The field 'resourceType' has the following description: Name of resource or null if scalars. Resource type matches declaration in datacollection-config.xml for presentation in Web UI and in RRD storage. Each table, that is collected, should generally be given their own resource type. MIB2 tables, however, need not be given a separate resourceType as they are handled out-of-box by ONMS.

Parameters:

resourceType - the value of field 'resourceType'.

unmarshal

public static Group 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.xmpDataCollection.Group

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