org.xwiki.mail

Class EmptyMailStatusResult

java.lang.Object

org.xwiki.mail.EmptyMailStatusResult

All Implemented Interfaces:

MailStatusResult

public class EmptyMailStatusResult
extends Object
implements MailStatusResult

An empty EmptyMailStatusResult.

Since:

12.6

Version:

$Id: 2695a722bb1964e507911c27c93f68a77d4a29b4 $

Field Summary

Fields

Modifier and Type	Field and Description
static EmptyMailStatusResult	INSTANCE An instance of EmptyMailStatusResult.

Constructor Summary

Constructors

Constructor and Description
EmptyMailStatusResult()

Method Summary

Modifier and Type	Method and Description
Iterator<MailStatus>	getAll()
Iterator<MailStatus>	getAllErrors()
Iterator<MailStatus>	getByState(MailState state)
long	getProcessedMailCount()
long	getTotalMailCount()
boolean	isProcessed()
void	waitTillProcessed(long timeout) Wait till all messages on the sending queue have been sent (for this batch) before returning.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final EmptyMailStatusResult INSTANCE

An instance of EmptyMailStatusResult.

Constructor Detail

EmptyMailStatusResult

public EmptyMailStatusResult()

Method Detail

getTotalMailCount

public long getTotalMailCount()

Specified by:

getTotalMailCount in interface MailStatusResult

Returns:

the total number of mails to be sent in this batch. Note that this value is known only once all mails have been prepared on the Prepare Queue. Until then, the value returned is -1 signifying that the total number is currently unknown. WARNING: If the preparation fails, this number will not reflect the total number of mails that should have been processed, but the number of mail that have been prepared with or without success.

getProcessedMailCount

public long getProcessedMailCount()

Specified by:

getProcessedMailCount in interface MailStatusResult

Returns:

the current number of mails that have been processed (sent with success or failed at any stage).

waitTillProcessed

public void waitTillProcessed(long timeout)

Description copied from interface: MailStatusResult

Wait till all messages on the sending queue have been sent (for this batch) before returning.

Specified by:

waitTillProcessed in interface MailStatusResult

Parameters:

timeout - the maximum amount of time to wait in milliseconds

isProcessed

public boolean isProcessed()

Specified by:

isProcessed in interface MailStatusResult

Returns:

true if all the mails from this batch have been processed (sent successfully or not) or false otherwise

getAll

public Iterator<MailStatus> getAll()

Specified by:

getAll in interface MailStatusResult

Returns:

the status for all mails

getAllErrors

public Iterator<MailStatus> getAllErrors()

Specified by:

getAllErrors in interface MailStatusResult

Returns:

the status for all messages in error.

getByState

public Iterator<MailStatus> getByState(MailState state)

Specified by:

getByState in interface MailStatusResult

Parameters:

state - the state to match (prepare_success, prepare_error, send_success, send_error or send_fatal_error)

Returns:

the status for all mails matching the passed state