org.opennms.netmgt.config.users

Class Header

java.lang.Object

org.opennms.netmgt.config.users.Header

All Implemented Interfaces:

Serializable

public class Header
extends Object
implements Serializable

Header containing information about this configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Header()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getCreated() Returns the value of field 'created'.
String	getMstation() Returns the value of field 'mstation'.
String	getRev() Returns the value of field 'rev'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setCreated(String created) Sets the value of field 'created'.
void	setMstation(String mstation) Sets the value of field 'mstation'.
void	setRev(String rev) Sets the value of field 'rev'.
static Header	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

Header

public Header()

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.

getCreated

public String getCreated()

Returns the value of field 'created'. The field 'created' has the following description: Creation time in the 'dow mon dd hh:mm:ss zzz yyyy' format.

Returns:

the value of field 'Created'.

getMstation

public String getMstation()

Returns the value of field 'mstation'. The field 'mstation' has the following description: Monitoring station? This is seemingly unused.

Returns:

the value of field 'Mstation'.

getRev

public String getRev()

Returns the value of field 'rev'. The field 'rev' has the following description: Revision of this file.

Returns:

the value of field 'Rev'.

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

setCreated

public void setCreated(String created)

Sets the value of field 'created'. The field 'created' has the following description: Creation time in the 'dow mon dd hh:mm:ss zzz yyyy' format.

Parameters:

created - the value of field 'created'.

setMstation

public void setMstation(String mstation)

Sets the value of field 'mstation'. The field 'mstation' has the following description: Monitoring station? This is seemingly unused.

Parameters:

mstation - the value of field 'mstation'.

setRev

public void setRev(String rev)

Sets the value of field 'rev'. The field 'rev' has the following description: Revision of this file.

Parameters:

rev - the value of field 'rev'.

unmarshal

public static Header 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.users.Heade

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