EmailRecipientSyncQueue

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.ibm.commerce.emarketing.engine.EmailRecipientSyncQueue

```
public class EmailRecipientSyncQueue
extends java.lang.Object
```
A synchronoized queue that is thread safe so that mutliple threads can process email in parrellel.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
Copyright.

Constructor Summary

Constructors
Constructor and Description

EmailRecipientSyncQueue()
Constructor.

EmailRecipientSyncQueue(java.util.List list)
Constructs instance from the passed list.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List`	`getQueueAsList()` returns the current queue as a list.
`boolean`	`isFinished()` Returns true when the queue is finished syncing.
`EmailRecipient`	`pop()` Pops a recipient from the queue.
`void`	`push(EmailRecipient emailRecipient)` Adds and email recipiient to the queue.
`void`	`setFinishedPushing(boolean flag)` Informs the queue that the application has finishing pushing data onto it.
`int`	`size()` returns the current size of the queue.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    Copyright.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EmailRecipientSyncQueue
```
public EmailRecipientSyncQueue()
```
    Constructor.
  - EmailRecipientSyncQueue
```
public EmailRecipientSyncQueue(java.util.List list)
```
    Constructs instance from the passed list.
    
    Parameters:
    
    list - the list to use.
- Method Detail
  - getQueueAsList
```
public java.util.List getQueueAsList()
```
    returns the current queue as a list.
    
    Returns:
    
    the current queue as a list.
  - isFinished
```
public boolean isFinished()
```
    Returns true when the queue is finished syncing.
    
    Returns:
    
    true when the queue is finished syncing.
  - pop
```
public EmailRecipient pop()
```
    Pops a recipient from the queue.
    
    Returns:
    
    the popped recipient.
  - push
```
public void push(EmailRecipient emailRecipient)
```
    Adds and email recipiient to the queue.
    
    Parameters:
    
    emailRecipient - the recipient to add.
  - setFinishedPushing
```
public void setFinishedPushing(boolean flag)
```
    Informs the queue that the application has finishing pushing data onto it.
    
    Parameters:
    
    flag - set to true when the app will not push mroe data.
  - size
```
public int size()
```
    returns the current size of the queue.
    
    Returns:
    
    the size of the queue.