org.opennms.netmgt.config.map.adapter

Class Csubmap

java.lang.Object

org.opennms.netmgt.config.map.adapter.Csubmap

All Implemented Interfaces:

Serializable

public class Csubmap
extends Object
implements Serializable

Class Csubmap.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Csubmap()

Method Summary

Modifier and Type	Method and Description
void	deleteAddwithoutelements()
void	deleteX()
void	deleteY()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
boolean	getAddwithoutelements() Returns the value of field 'addwithoutelements'.
String	getIcon() Returns the value of field 'icon'.
String	getLabel() Returns the value of field 'label'.
String	getName() Returns the value of field 'name'.
int	getX() Returns the value of field 'x'.
int	getY() Returns the value of field 'y'.
boolean	hasAddwithoutelements() Method hasAddwithoutelements.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasX() Method hasX.
boolean	hasY() Method hasY.
boolean	isAddwithoutelements() Returns the value of field 'addwithoutelements'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setAddwithoutelements(boolean addwithoutelements) Sets the value of field 'addwithoutelements'.
void	setIcon(String icon) Sets the value of field 'icon'.
void	setLabel(String label) Sets the value of field 'label'.
void	setName(String name) Sets the value of field 'name'.
void	setX(int x) Sets the value of field 'x'.
void	setY(int y) Sets the value of field 'y'.
static Csubmap	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

Csubmap

public Csubmap()

Method Detail

deleteAddwithoutelements

public void deleteAddwithoutelements()

deleteX

public void deleteX()

deleteY

public void deleteY()

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.

getAddwithoutelements

public boolean getAddwithoutelements()

Returns the value of field 'addwithoutelements'. The field 'addwithoutelements' has the following description: Whether MapsAdapter should add the submap if it has no elements.

Returns:

the value of field 'Addwithoutelements'.

getIcon

public String getIcon()

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

Returns:

the value of field 'Icon'.

getLabel

public String getLabel()

Returns the value of field 'label'. The field 'label' has the following description: The Label of the submap

Returns:

the value of field 'Label'.

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: The Name of the submap to add. This map must exist.

Returns:

the value of field 'Name'.

getX

public int getX()

Returns the value of field 'x'. The field 'x' has the following description: The x coordinate position of the element

Returns:

the value of field 'X'.

getY

public int getY()

Returns the value of field 'y'. The field 'y' has the following description: The y coordinate position of the element

Returns:

the value of field 'Y'.

hasAddwithoutelements

public boolean hasAddwithoutelements()

Method hasAddwithoutelements.

Returns:

true if at least one Addwithoutelements has been adde

hasX

public boolean hasX()

Method hasX.

Returns:

true if at least one X has been added

hasY

public boolean hasY()

Method hasY.

Returns:

true if at least one Y has been added

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.

isAddwithoutelements

public boolean isAddwithoutelements()

Returns the value of field 'addwithoutelements'. The field 'addwithoutelements' has the following description: Whether MapsAdapter should add the submap if it has no elements.

Returns:

the value of field 'Addwithoutelements'.

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

setAddwithoutelements

public void setAddwithoutelements(boolean addwithoutelements)

Sets the value of field 'addwithoutelements'. The field 'addwithoutelements' has the following description: Whether MapsAdapter should add the submap if it has no elements.

Parameters:

addwithoutelements - the value of field 'addwithoutelements'.

setIcon

public void setIcon(String icon)

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

Parameters:

icon - the value of field 'icon'.

setLabel

public void setLabel(String label)

Sets the value of field 'label'. The field 'label' has the following description: The Label of the submap

Parameters:

label - the value of field 'label'.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: The Name of the submap to add. This map must exist.

Parameters:

name - the value of field 'name'.

setX

public void setX(int x)

Sets the value of field 'x'. The field 'x' has the following description: The x coordinate position of the element

Parameters:

x - the value of field 'x'.

setY

public void setY(int y)

Sets the value of field 'y'. The field 'y' has the following description: The y coordinate position of the element

Parameters:

y - the value of field 'y'.

unmarshal

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

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