org.opennms.netmgt.config.javamail

Class ReadmailProtocol

java.lang.Object

org.opennms.netmgt.config.javamail.ReadmailProtocol

All Implemented Interfaces:

Serializable

public class ReadmailProtocol
extends Object
implements Serializable

Basically any attributes that help setup the javamailer's confusing set of properties.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReadmailProtocol()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteSslEnable()
void	deleteStartTls()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
boolean	getSslEnable() Returns the value of field 'sslEnable'.
boolean	getStartTls() Returns the value of field 'startTls'.
String	getTransport() Returns the value of field 'transport'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasSslEnable() Method hasSslEnable.
boolean	hasStartTls() Method hasStartTls.
boolean	isSslEnable() Returns the value of field 'sslEnable'.
boolean	isStartTls() Returns the value of field 'startTls'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setSslEnable(boolean sslEnable) Sets the value of field 'sslEnable'.
void	setStartTls(boolean startTls) Sets the value of field 'startTls'.
void	setTransport(String transport) Sets the value of field 'transport'.
static ReadmailProtocol	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

ReadmailProtocol

public ReadmailProtocol()

Method Detail

deleteSslEnable

public void deleteSslEnable()

deleteStartTls

public void deleteStartTls()

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.

getSslEnable

public boolean getSslEnable()

Returns the value of field 'sslEnable'.

Returns:

the value of field 'SslEnable'.

getStartTls

public boolean getStartTls()

Returns the value of field 'startTls'.

Returns:

the value of field 'StartTls'.

getTransport

public String getTransport()

Returns the value of field 'transport'.

Returns:

the value of field 'Transport'.

hasSslEnable

public boolean hasSslEnable()

Method hasSslEnable.

Returns:

true if at least one SslEnable has been added

hasStartTls

public boolean hasStartTls()

Method hasStartTls.

Returns:

true if at least one StartTls 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.

isSslEnable

public boolean isSslEnable()

Returns the value of field 'sslEnable'.

Returns:

the value of field 'SslEnable'.

isStartTls

public boolean isStartTls()

Returns the value of field 'startTls'.

Returns:

the value of field 'StartTls'.

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

setSslEnable

public void setSslEnable(boolean sslEnable)

Sets the value of field 'sslEnable'.

Parameters:

sslEnable - the value of field 'sslEnable'.

setStartTls

public void setStartTls(boolean startTls)

Sets the value of field 'startTls'.

Parameters:

startTls - the value of field 'startTls'.

setTransport

public void setTransport(String transport)

Sets the value of field 'transport'.

Parameters:

transport - the value of field 'transport'.

unmarshal

public static ReadmailProtocol 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.ReadmailProtocol

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