org.opennms.netmgt.config.map.adapter

Class Celement

java.lang.Object

org.opennms.netmgt.config.map.adapter.Celement

All Implemented Interfaces:

Serializable

public class Celement
extends Object
implements Serializable

A Rule for adding elements to the map automatically

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Celement()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getIcon() Returns the value of field 'icon'.
String	getPackage() Returns the value of field 'package'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setIcon(String icon) Sets the value of field 'icon'.
void	setPackage(String _package) Sets the value of field 'package'.
static Celement	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

Celement

public Celement()

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.

getIcon

public String getIcon()

Returns the value of field 'icon'. The field 'icon' has the following description: The icon of the element to add

Returns:

the value of field 'Icon'.

getPackage

public String getPackage()

Returns the value of field 'package'. The field 'package' has the following description: The package used to get elements

Returns:

the value of field 'Package'.

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

setIcon

public void setIcon(String icon)

Sets the value of field 'icon'. The field 'icon' has the following description: The icon of the element to add

Parameters:

icon - the value of field 'icon'.

setPackage

public void setPackage(String _package)

Sets the value of field 'package'. The field 'package' has the following description: The package used to get elements

Parameters:

_package -

package - the value of field 'package'.

unmarshal

public static Celement 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.map.adapter.Celement

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