org.opennms.netmgt.config.javamail

Class ReadmailHost

java.lang.Object

org.opennms.netmgt.config.javamail.ReadmailHost

All Implemented Interfaces:

Serializable

public class ReadmailHost
extends Object
implements Serializable

Define the host and port of a service for reading email.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReadmailHost()

Method Summary

Methods

Modifier and Type	Method and Description
void	deletePort()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getHost() Returns the value of field 'host'.
long	getPort() Returns the value of field 'port'.
ReadmailProtocol	getReadmailProtocol() Returns the value of field 'readmailProtocol'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasPort() Method hasPort.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setHost(String host) Sets the value of field 'host'.
void	setPort(long port) Sets the value of field 'port'.
void	setReadmailProtocol(ReadmailProtocol readmailProtocol) Sets the value of field 'readmailProtocol'.
static ReadmailHost	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

ReadmailHost

public ReadmailHost()

Method Detail

deletePort

public void deletePort()

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.

getHost

public String getHost()

Returns the value of field 'host'.

Returns:

the value of field 'Host'.

getPort

public long getPort()

Returns the value of field 'port'.

Returns:

the value of field 'Port'.

getReadmailProtocol

public ReadmailProtocol getReadmailProtocol()

Returns the value of field 'readmailProtocol'. The field 'readmailProtocol' has the following description: Basically any attributes that help setup the javamailer's confusing set of properties.

Returns:

the value of field 'ReadmailProtocol'.

hasPort

public boolean hasPort()

Method hasPort.

Returns:

true if at least one Port has been added

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

setHost

public void setHost(String host)

Sets the value of field 'host'.

Parameters:

host - the value of field 'host'.

setPort

public void setPort(long port)

Sets the value of field 'port'.

Parameters:

port - the value of field 'port'.

setReadmailProtocol

public void setReadmailProtocol(ReadmailProtocol readmailProtocol)

Sets the value of field 'readmailProtocol'. The field 'readmailProtocol' has the following description: Basically any attributes that help setup the javamailer's confusing set of properties.

Parameters:

readmailProtocol - the value of field 'readmailProtocol'

unmarshal

public static ReadmailHost 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.javamail.ReadmailHost

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