org.opennms.netmgt.config.groups

Class Groupinfo

java.lang.Object

org.opennms.netmgt.config.groups.Groupinfo

All Implemented Interfaces:

Serializable

public class Groupinfo
extends Object
implements Serializable

Top-level element for the groups.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Groupinfo()

Method Summary

Methods

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'.
Header	getHeader() Returns the value of field 'header'.
Roles	getRoles() Returns the value of field 'roles'.
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	setHeader(Header header) Sets the value of field 'header'.
void	setRoles(Roles roles) Sets the value of field 'roles'.
static Groupinfo	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

Groupinfo

public Groupinfo()

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'.

Returns:

the value of field 'Groups'.

getHeader

public Header getHeader()

Returns the value of field 'header'. The field 'header' has the following description: Header containing information about this configuration file.

Returns:

the value of field 'Header'.

getRoles

public Roles getRoles()

Returns the value of field 'roles'.

Returns:

the value of field 'Roles'.

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'.

Parameters:

groups - the value of field 'groups'.

setHeader

public void setHeader(Header header)

Sets the value of field 'header'. The field 'header' has the following description: Header containing information about this configuration file.

Parameters:

header - the value of field 'header'.

setRoles

public void setRoles(Roles roles)

Sets the value of field 'roles'.

Parameters:

roles - the value of field 'roles'.

unmarshal

public static Groupinfo 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.groups.Groupinfo

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