org.opennms.netmgt.config.categories
Class Categorygroup

java.lang.Object
  org.opennms.netmgt.config.categories.Categorygroup

All Implemented Interfaces:

Serializable

public class Categorygroup
extends Object
implements Serializable

A category group containing categories. The only parts of the category group that seem to be used are the common element and the list of categories.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Categorygroup()

Method Summary

boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Categories	getCategories() Returns the value of field 'categories'.
String	getComment() Returns the value of field 'comment'.
Common	getCommon() Returns the value of field 'common'.
String	getName() Returns the value of field 'name'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setCategories(Categories categories) Sets the value of field 'categories'.
void	setComment(String comment) Sets the value of field 'comment'.
void	setCommon(Common common) Sets the value of field 'common'.
void	setName(String name) Sets the value of field 'name'.
static Categorygroup	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

Categorygroup

public Categorygroup()

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.

getCategories

public Categories getCategories()

Returns the value of field 'categories'. The field 'categories' has the following description: The categories belonging to this category group.

Returns:

the value of field 'Categories'.

getComment

public String getComment()

Returns the value of field 'comment'. The field 'comment' has the following description: A comment describing the category group. This is seemingly unused.

Returns:

the value of field 'Comment'.

getCommon

public Common getCommon()

Returns the value of field 'common'. The field 'common' has the following description: Common attributes that apply to all categories in the group.

Returns:

the value of field 'Common'.

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: The name of the category group. This is seemingly unused.

Returns:

the value of field 'Name'.

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

setCategories

public void setCategories(Categories categories)

Sets the value of field 'categories'. The field 'categories' has the following description: The categories belonging to this category group.

Parameters:

categories - the value of field 'categories'.

setComment

public void setComment(String comment)

Sets the value of field 'comment'. The field 'comment' has the following description: A comment describing the category group. This is seemingly unused.

Parameters:

comment - the value of field 'comment'.

setCommon

public void setCommon(Common common)

Sets the value of field 'common'. The field 'common' has the following description: Common attributes that apply to all categories in the group.

Parameters:

common - the value of field 'common'.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: The name of the category group. This is seemingly unused.

Parameters:

name - the value of field 'name'.

unmarshal

public static Categorygroup 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.categories.Categorygroup

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