com.hazelcast.client.impl.protocol.template

Interface QueueCodecTemplate

public interface QueueCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	addAll(String name, List<Data> dataList) Adds all of the elements in the specified collection to this collection (optional operation).The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
Object	addListener(String name, boolean includeValue, boolean localOnly) Adds an listener for this collection.
void	clear(String name) Removes all of the elements from this collection (optional operation).
Object	compareAndRemoveAll(String name, List<Data> dataList) Removes all of this collection's elements that are also contained in the specified collection (optional operation).
Object	compareAndRetainAll(String name, List<Data> dataList) Retains only the elements in this collection that are contained in the specified collection (optional operation).
Object	contains(String name, Data value) Returns true if this queue contains the specified element.
Object	containsAll(String name, List<Data> dataList) Return true if this collection contains all of the elements in the specified collection.
Object	drainTo(String name) Removes all available elements from this queue and adds them to the given collection.
Object	drainToMaxSize(String name, int maxSize) Removes at most the given number of available elements from this queue and adds them to the given collection.
Object	isEmpty(String name) Returns true if this collection contains no elements.
Object	iterator(String name) Returns an iterator over the elements in this collection.
Object	offer(String name, Data value, long timeoutMillis) Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.
Object	peek(String name) Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
Object	poll(String name, long timeoutMillis) Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.
void	put(String name, Data value) Inserts the specified element into this queue, waiting if necessary for space to become available.
Object	remainingCapacity(String name) Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking, or Integer.MAX_VALUE if there is no intrinsic limit.
Object	remove(String name, Data value) Retrieves and removes the head of this queue.
Object	removeListener(String name, String registrationId) Removes the specified item listener.Returns silently if the specified listener was not added before.
Object	size(String name) Returns the number of elements in this collection.
Object	take(String name) Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

Method Detail

offer

Object offer(String name,
           Data value,
           long timeoutMillis)

Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.

Parameters:

name - Name of the Queue

value - The element to add

timeoutMillis - Maximum time in milliseconds to wait for acquiring the lock for the key.

Returns:

True if the element was added to this queue, else false

put

void put(String name,
       Data value)

Inserts the specified element into this queue, waiting if necessary for space to become available.

Parameters:

name - Name of the Queue

value - The element to add

size

Object size(String name)

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE

Parameters:

name - Name of the Queue

Returns:

The number of elements in this collection

remove

Object remove(String name,
            Data value)

Retrieves and removes the head of this queue. This method differs from poll only in that it throws an exception if this queue is empty.

Parameters:

name - Name of the Queue

value - Element to be removed from this queue, if present

Returns:

true if this queue changed as a result of the call

poll

Object poll(String name,
          long timeoutMillis)

Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.

Parameters:

name - Name of the Queue

timeoutMillis - Maximum time in milliseconds to wait for acquiring the lock for the key.

Returns:

The head of this queue, or null if this queue is empty

take

Object take(String name)

Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

Parameters:

name - Name of the Queue

Returns:

The head of this queue

peek

Object peek(String name)

Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.

Parameters:

name - Name of the Queue

Returns:

The head of this queue, or null if this queue is empty

iterator

Object iterator(String name)

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Parameters:

name - Name of the Queue

Returns:

list of all data in queue

drainTo

Object drainTo(String name)

Removes all available elements from this queue and adds them to the given collection. This operation may be more efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in ILLEGAL_ARGUMENT. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters:

name - Name of the Queue

Returns:

list of all removed data in queue

drainToMaxSize

Object drainToMaxSize(String name,
                    int maxSize)

Removes at most the given number of available elements from this queue and adds them to the given collection. A failure encountered while attempting to add elements to collection may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in ILLEGAL_ARGUMENT. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters:

name - Name of the Queue

maxSize - The maximum number of elements to transfer

Returns:

list of all removed data in result of this method

contains

Object contains(String name,
              Data value)

Returns true if this queue contains the specified element. More formally, returns true if and only if this queue contains at least one element e such that value.equals(e)

Parameters:

name - Name of the Queue

value - Element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element

containsAll

Object containsAll(String name,
                 List<Data> dataList)

Return true if this collection contains all of the elements in the specified collection.

Parameters:

name - Name of the Queue

dataList - Collection to be checked for containment in this collection

Returns:

true if this collection contains all of the elements in the specified collection

compareAndRemoveAll

Object compareAndRemoveAll(String name,
                         List<Data> dataList)

Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Parameters:

name - Name of the Queue

dataList - Collection containing elements to be removed from this collection

Returns:

true if this collection changed as a result of the call

compareAndRetainAll

Object compareAndRetainAll(String name,
                         List<Data> dataList)

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Parameters:

name - Name of the Queue

dataList - collection containing elements to be retained in this collection

Returns:

true if this collection changed as a result of the call

clear

void clear(String name)

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

Parameters:

name - Name of the Queue

addAll

Object addAll(String name,
            List<Data> dataList)

Adds all of the elements in the specified collection to this collection (optional operation).The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

Parameters:

name - Name of the Queue

dataList - Collection containing elements to be added to this collection

Returns:

true if this collection changed as a result of the call

addListener

Object addListener(String name,
                 boolean includeValue,
                 boolean localOnly)

Adds an listener for this collection. Listener will be notified or all collection add/remove events.

Parameters:

name - Name of the Queue

includeValue - true if the updated item should be passed to the item listener, false otherwise.

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

The registration id

removeListener

Object removeListener(String name,
                    String registrationId)

Removes the specified item listener.Returns silently if the specified listener was not added before.

Parameters:

name - Name of the Queue

registrationId - Id of the listener registration.

Returns:

True if the item listener is removed, false otherwise

remainingCapacity

Object remainingCapacity(String name)

Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking, or Integer.MAX_VALUE if there is no intrinsic limit. Note that you cannot always tell if an attempt to insert an element will succeed by inspecting remainingCapacity because it may be the case that another thread is about to insert or remove an element.

Parameters:

name - Name of the Queue

Returns:

The remaining capacity

isEmpty

Object isEmpty(String name)

Returns true if this collection contains no elements.

Parameters:

name - Name of the Queue

Returns:

True if this collection contains no elements