WriteBehindQueue (hazelcast-client-protocol 1.6.0-5 API)

Type Parameters:

E - the type of element to be stored in this queue.
```
public interface WriteBehindQueue<E>
```
A specific queue implementation which is used for write-behind-store operations. Also supports filtering via filter(IPredicate, Collection)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addFirst(Collection<E> collection)` Inserts collection of elements to the front of this queue.
`void`	`addLast(E e)` Inserts to the end of this queue.
`List<E>`	`asList()` Returns a read-only list representation of this queue.
`void`	`clear()` Removes all of the elements in this `WriteBehindQueue` Queue will be empty after this method returns.
`boolean`	`contains(E e)` Checks whether an element exist in this queue.
`int`	`drainTo(Collection<E> collection)` Removes all elements from this queue and adds them to the given collection.
`void`	`filter(IPredicate<E> predicate, Collection<E> collection)` Filters this queue according to supplied predicate.
`E`	`peek()` Retrieves, but does not remove, the head of this queue, or returns `null` if this queue is empty.
`boolean`	`removeFirstOccurrence(E e)` Removes the first occurrence of the specified element in this queue when searching it by starting from the head of this queue.
`int`	`size()` Returns the number of elements in this `WriteBehindQueue`.

- Method Detail
  - addFirst
```
void addFirst(Collection<E> collection)
```
    Inserts collection of elements to the front of this queue.
    
    Parameters:
    
    collection - collection of elements to be inserted in front of this queue.
  - addLast
```
void addLast(E e)
```
    Inserts to the end of this queue.
    
    Parameters:
    
    e - element to be offered
  - peek
```
E peek()
```
    Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
    
    Returns:
    
    the head of this queue, or null if this queue is empty
  - removeFirstOccurrence
```
boolean removeFirstOccurrence(E e)
```
    Removes the first occurrence of the specified element in this queue when searching it by starting from the head of this queue.
    
    Parameters:
    
    e - element to be removed.
    
    Returns:
    
    true if removed successfully, false otherwise
  - drainTo
```
int drainTo(Collection<E> collection)
```
    Removes all elements from this queue and adds them to the given collection.
    
    Parameters:
    
    collection - all elements to be added to this collection.
    
    Returns:
    
    number of removed items from this queue.
  - contains
```
boolean contains(E e)
```
    Checks whether an element exist in this queue.
    
    Parameters:
    
    e - item to be checked
    
    Returns:
    
    true if exists, false otherwise
  - size
```
int size()
```
    Returns the number of elements in this WriteBehindQueue.
    
    Returns:
    
    the number of elements in this WriteBehindQueue.
  - clear
```
void clear()
```
    Removes all of the elements in this WriteBehindQueue Queue will be empty after this method returns.
  - asList
```
List<E> asList()
```
    Returns a read-only list representation of this queue.
    
    Returns:
    
    read-only list representation of this queue.
  - filter
```
void filter(IPredicate<E> predicate,
            Collection<E> collection)
```
    Filters this queue according to supplied predicate.
    
    Parameters:
    
    predicate - used to filter this queue
    
    collection - filtered entries will be added to this collection

Interface WriteBehindQueue<E>

Method Summary

Method Detail

addFirst

addLast

peek

removeFirstOccurrence

drainTo

contains

size

clear

asList

filter