org.opennms.netmgt.config.xmpDataCollection

Class XmpCollection

java.lang.Object

org.opennms.netmgt.config.xmpDataCollection.XmpCollection

All Implemented Interfaces:

Serializable

public class XmpCollection
extends Object
implements Serializable

a grouping of XMP related RRD parms, MIB object groups and sysoid based system definitions.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmpCollection()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Groups	getGroups() Returns the value of field 'groups'.
String	getName() Returns the value of field 'name'.
Rrd	getRrd() Returns the value of field 'rrd'.
String	getXmpStorageFlag() Returns the value of field 'xmpStorageFlag'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setGroups(Groups groups) Sets the value of field 'groups'.
void	setName(String name) Sets the value of field 'name'.
void	setRrd(Rrd rrd) Sets the value of field 'rrd'.
void	setXmpStorageFlag(String xmpStorageFlag) Sets the value of field 'xmpStorageFlag'.
static XmpCollection	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

XmpCollection

public XmpCollection()

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.

getGroups

public Groups getGroups()

Returns the value of field 'groups'. The field 'groups' has the following description: MIB object groups

Returns:

the value of field 'Groups'.

getName

public String getName()

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

Returns:

the value of field 'Name'.

getRrd

public Rrd getRrd()

Returns the value of field 'rrd'. The field 'rrd' has the following description: RRD parms

Returns:

the value of field 'Rrd'.

getXmpStorageFlag

public String getXmpStorageFlag()

Returns the value of field 'xmpStorageFlag'. The field 'xmpStorageFlag' has the following description: indicates if collected XMP data is to be stored for "all" interfaces or only for the "primary" interface. Currently ignored.

Returns:

the value of field 'XmpStorageFlag'.

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

setGroups

public void setGroups(Groups groups)

Sets the value of field 'groups'. The field 'groups' has the following description: MIB object groups

Parameters:

groups - the value of field 'groups'.

setName

public void setName(String name)

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

Parameters:

name - the value of field 'name'.

setRrd

public void setRrd(Rrd rrd)

Sets the value of field 'rrd'. The field 'rrd' has the following description: RRD parms

Parameters:

rrd - the value of field 'rrd'.

setXmpStorageFlag

public void setXmpStorageFlag(String xmpStorageFlag)

Sets the value of field 'xmpStorageFlag'. The field 'xmpStorageFlag' has the following description: indicates if collected XMP data is to be stored for "all" interfaces or only for the "primary" interface. Currently ignored.

Parameters:

xmpStorageFlag - the value of field 'xmpStorageFlag'.

unmarshal

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

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