org.opennms.netmgt.config.xmpDataCollection
Class MibObj

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

All Implemented Interfaces:

Serializable

public class MibObj
extends Object
implements Serializable

a MIB object

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MibObj()

Method Summary

boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getAlias() Returns the value of field 'alias'.
String	getInstance() Returns the value of field 'instance'.
String	getMib() Returns the value of field 'mib'.
String	getTable() Returns the value of field 'table'.
String	getVar() Returns the value of field 'var'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setAlias(String alias) Sets the value of field 'alias'.
void	setInstance(String instance) Sets the value of field 'instance'.
void	setMib(String mib) Sets the value of field 'mib'.
void	setTable(String table) Sets the value of field 'table'.
void	setVar(String var) Sets the value of field 'var'.
static MibObj	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

MibObj

public MibObj()

Method Detail

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'. The field 'alias' has the following description: a human readable name for the object (such as "ifOctetsIn"). NOTE: This value is used as the RRD file name and data source name. RRD only supports data source names up to 19 chars in length. If the XMP data collector encounters an alias which exceeds 19 characters it will be truncated.

Returns:

the value of field 'Alias'.

getInstance

public String getInstance()

Returns the value of field 'instance'. The field 'instance' has the following description: Instance identifier or empty string. If not empty, this string will be used for table queries.

Returns:

the value of field 'Instance'.

getMib

public String getMib()

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

Returns:

the value of field 'Mib'.

getTable

public String getTable()

Returns the value of field 'table'. The field 'table' has the following description: MIB table name or empty string if scalar

Returns:

the value of field 'Table'.

getVar

public String getVar()

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

Returns:

the value of field 'Var'.

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

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

setAlias

public void setAlias(String alias)

Sets the value of field 'alias'. The field 'alias' has the following description: a human readable name for the object (such as "ifOctetsIn"). NOTE: This value is used as the RRD file name and data source name. RRD only supports data source names up to 19 chars in length. If the XMP data collector encounters an alias which exceeds 19 characters it will be truncated.

Parameters:

alias - the value of field 'alias'.

setInstance

public void setInstance(String instance)

Sets the value of field 'instance'. The field 'instance' has the following description: Instance identifier or empty string. If not empty, this string will be used for table queries.

Parameters:

instance - the value of field 'instance'.

setMib

public void setMib(String mib)

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

Parameters:

mib - the value of field 'mib'.

setTable

public void setTable(String table)

Sets the value of field 'table'. The field 'table' has the following description: MIB table name or empty string if scalar

Parameters:

table - the value of field 'table'.

setVar

public void setVar(String var)

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

Parameters:

var - the value of field 'var'.

unmarshal

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

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