org.opennms.netmgt.config.rancid.adapter

Class Time

java.lang.Object

org.opennms.netmgt.config.rancid.adapter.Time

All Implemented Interfaces:

Serializable

public class Time
extends Object
implements Serializable

defines start/end time for the outage

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Time()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getBegins() Returns the value of field 'begins'.
String	getDay() Returns the value of field 'day'.
String	getEnds() Returns the value of field 'ends'.
String	getId() Returns the value of field 'id'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setBegins(String begins) Sets the value of field 'begins'.
void	setDay(String day) Sets the value of field 'day'.
void	setEnds(String ends) Sets the value of field 'ends'.
void	setId(String id) Sets the value of field 'id'.
static Time	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

Time

public Time()

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.

getBegins

public String getBegins()

Returns the value of field 'begins'. The field 'begins' has the following description: when the outage starts

Returns:

the value of field 'Begins'.

getDay

public String getDay()

Returns the value of field 'day'.

Returns:

the value of field 'Day'.

getEnds

public String getEnds()

Returns the value of field 'ends'. The field 'ends' has the following description: when the outage ends

Returns:

the value of field 'Ends'.

getId

public String getId()

Returns the value of field 'id'. The field 'id' has the following description: an identifier for this event used for reference in the web gui. If this identifer is not assigned it will be assigned an identifer by web gui.

Returns:

the value of field 'Id'.

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

setBegins

public void setBegins(String begins)

Sets the value of field 'begins'. The field 'begins' has the following description: when the outage starts

Parameters:

begins - the value of field 'begins'.

setDay

public void setDay(String day)

Sets the value of field 'day'.

Parameters:

day - the value of field 'day'.

setEnds

public void setEnds(String ends)

Sets the value of field 'ends'. The field 'ends' has the following description: when the outage ends

Parameters:

ends - the value of field 'ends'.

setId

public void setId(String id)

Sets the value of field 'id'. The field 'id' has the following description: an identifier for this event used for reference in the web gui. If this identifer is not assigned it will be assigned an identifer by web gui.

Parameters:

id - the value of field 'id'.

unmarshal

public static Time 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.rancid.adapter.Time

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