1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.mail.internal.thread

File MailQueueManager.java

 

Code metrics

0
0
0
1
58
10
0
-
-
0
-

Classes

Class Line # Actions
MailQueueManager 32 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.mail.internal.thread;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Handles all operations on the Mail Queues.
26    *
27    * @version $Id: e325e815eef09e07dcc61113f6770dacd634a59c $
28    * @since 6.4
29    * @param <T> the type of the Mail Queue Item managed by the Queue Manager
30    */
31    @Role
 
32    public interface MailQueueManager<T extends MailQueueItem>
33    {
34    /**
35    * Add a mail on the queue for processing.
36    *
37    * @param mailQueueItem the object representing the mail item to add to the queue
38    */
39    void addToQueue(T mailQueueItem);
40   
41    /**
42    * @return true if the queue has messages waiting for processing
43    */
44    boolean hasMessage();
45   
46    /**
47    * @return the next mail on the queue waiting to be processed
48    */
49    T peekMessage();
50   
51    /**
52    * Removes the next mail on the queue.
53    *
54    * @param mailQueueItem the object representing the mail to remove from the queue
55    * @return true if the removal was successful, false otherwise
56    */
57    boolean removeMessageFromQueue(T mailQueueItem);
58    }