org.opennms.netmgt.config.snmpAsset.adapter

Class MibObjs

java.lang.Object

org.opennms.netmgt.config.snmpAsset.adapter.MibObjs

All Implemented Interfaces:

Serializable

public class MibObjs
extends Object
implements Serializable

Class MibObjs.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MibObjs()

Method Summary

Modifier and Type	Method and Description
void	addMibObj(int index, MibObj vMibObj)
void	addMibObj(MibObj vMibObj)
Enumeration<MibObj>	enumerateMibObj() Method enumerateMibObj.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
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.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<MibObj>	iterateMibObj() Method iterateMibObj.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllMibObj()
boolean	removeMibObj(MibObj vMibObj) Method removeMibObj.
MibObj	removeMibObjAt(int index) Method removeMibObjAt.
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.
static MibObjs	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

MibObjs

public MibObjs()

Method Detail

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

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.

getMibObj

public MibObj getMibObj(int index)
                 throws IndexOutOfBoundsException

Method getMibObj.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.snmpAsset.adapter.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

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

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

removeAllMibObj

public void removeAllMibObj()

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

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.

unmarshal

public static MibObjs 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.snmpAsset.adapter.MibObjs

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