org.opennms.netmgt.config.archiver.events

Class EventsArchiverConfiguration

java.lang.Object

org.opennms.netmgt.config.archiver.events.EventsArchiverConfiguration

All Implemented Interfaces:

Serializable

public class EventsArchiverConfiguration
extends Object
implements Serializable

The top-level element for the events-archiver-configuration.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EventsArchiverConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getArchiveAge() Returns the value of field 'archiveAge'.
String	getSeparator() Returns the value of field 'separator'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setArchiveAge(String archiveAge) Sets the value of field 'archiveAge'.
void	setSeparator(String separator) Sets the value of field 'separator'.
static EventsArchiverConfiguration	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

EventsArchiverConfiguration

public EventsArchiverConfiguration()

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.

getArchiveAge

public String getArchiveAge()

Returns the value of field 'archiveAge'. The field 'archiveAge' has the following description: Archive age. Events older than current time minus this time are removed (is typically in days, hours, minutes although seconds, milliseconds and microseconds are also supported).

Returns:

the value of field 'ArchiveAge'.

getSeparator

public String getSeparator()

Returns the value of field 'separator'. The field 'separator' has the following description: Separator used in between event table column values when an event is written to the archive file.

Returns:

the value of field 'Separator'.

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

setArchiveAge

public void setArchiveAge(String archiveAge)

Sets the value of field 'archiveAge'. The field 'archiveAge' has the following description: Archive age. Events older than current time minus this time are removed (is typically in days, hours, minutes although seconds, milliseconds and microseconds are also supported).

Parameters:

archiveAge - the value of field 'archiveAge'.

setSeparator

public void setSeparator(String separator)

Sets the value of field 'separator'. The field 'separator' has the following description: Separator used in between event table column values when an event is written to the archive file.

Parameters:

separator - the value of field 'separator'.

unmarshal

public static EventsArchiverConfiguration 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.archiver.events.EventsArchiverConfiguration

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