com.jalios.jcms.mail

Class AbstractMailListener

java.lang.Object

com.jalios.jcms.mail.AbstractMailListener

All Implemented Interfaces:

MailListener, java.lang.Comparable

Direct Known Subclasses:

ArchiveMailListener, AttachementsMailListener, MemberMailListener, ThreadMailListener

public abstract class AbstractMailListener
extends java.lang.Object
implements MailListener

Version:

$Revision: 24128 $

Author:

Jean-Philippe Encausse

Field Summary

Fields

Modifier and Type	Field and Description
protected int	order
static java.lang.String	REVISION

Constructor Summary

Constructors

Constructor and Description
AbstractMailListener()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object obj) Compare this object with the specified object for order.
boolean	equals(MailListener obj) Indicates wheter some other object is "equal to" this one.
boolean	fetchMessage(MailMessage mail, boolean stored, java.util.Map<java.lang.String,java.lang.Object> context) Invoked after a mail was fetch.
int	getOrder() Returns object orders value.
void	setOrder(int order) Sets the listener order

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

order

protected int order

Constructor Detail

AbstractMailListener

public AbstractMailListener()

Method Detail

fetchMessage

public boolean fetchMessage(MailMessage mail,
                   boolean stored,
                   java.util.Map<java.lang.String,java.lang.Object> context)

Description copied from interface: MailListener

Invoked after a mail was fetch.

Specified by:

fetchMessage in interface MailListener

Parameters:

mail - the javax.mail.Message fetched

stored - boolean to store MailMessage in JCMS

context - a context used to store information

Returns:

boolean stored

See Also:

MailListener.fetchMessage(MailMessage, boolean, Map)

getOrder

public final int getOrder()

Returns object orders value.

Returns:

int object orders value.

setOrder

public final void setOrder(int order)

Sets the listener order

Parameters:

order -

compareTo

public final int compareTo(java.lang.Object obj)

Compare this object with the specified object for order.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - the Object to be compared.

See Also:

Comparable.compareTo(java.lang.Object)

equals

public final boolean equals(MailListener obj)

Indicates wheter some other object is "equal to" this one. The comparison is performed with compareTo() method.

Parameters:

obj - the Object to be compared.

Returns:

true if equal