GridCacheQueueAdapter (gridgain-core 6.1.9 API)

java.lang.Object
- java.util.AbstractCollection<T>
- - org.gridgain.grid.kernal.processors.cache.datastructures.GridCacheQueueAdapter<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, BlockingQueue<T>, Queue<T>, GridCacheQueue<T>

Direct Known Subclasses:

GridAtomicCacheQueueImpl, GridTransactionalCacheQueueImpl
```
public abstract class GridCacheQueueAdapter<T>
extends AbstractCollection<T>
implements GridCacheQueue<T>
```
Common code for GridCacheQueue implementation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`GridCacheQueueAdapter.AddClosure`
`protected static class`	`GridCacheQueueAdapter.ClearClosure`
`protected static class`	`GridCacheQueueAdapter.PollClosure`
`protected static class`	`GridCacheQueueAdapter.RemoveClosure`

Field Summary

Fields
Modifier and Type	Field and Description
`protected GridCacheAdapter`	`cache` Cache.
`protected GridCacheContext<?,?>`	`cctx` Cache context.
`protected GridUuid`	`id` Queue unique ID.
`protected GridLogger`	`log` Logger.
`protected static int`	`MAX_UPDATE_RETRIES`
`protected static long`	`QUEUE_REMOVED_IDX` Value returned by closure updating queue header indicating that queue was removed.
`protected GridCacheQueueHeaderKey`	`queueKey` Queue header key.
`protected String`	`queueName` Queue name.
`protected static long`	`RETRY_DELAY`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GridCacheQueueAdapter(String queueName, GridCacheQueueHeader hdr, GridCacheContext<?,?> cctx)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(T item)`
`boolean`	`bounded()` Returns `true` if this queue is bounded.
`int`	`capacity()` Gets maximum number of elements of the queue.
`protected void`	`checkRemoved(GridCacheQueueHeader hdr)` Checks queue state, throws `GridCacheDataStructureRemovedRuntimeException` if queue was removed.
`protected void`	`checkRemoved(Long idx)` Checks result of closure modifying queue header, throws `GridCacheDataStructureRemovedRuntimeException` if queue was removed.
`void`	`clear(int batchSize)` Removes all of the elements from this queue.
`boolean`	`collocated()` Returns `true` if this queue can be kept on the one node only.
`int`	`drainTo(Collection<? super T> c)`
`int`	`drainTo(Collection<? super T> c, int maxElements)`
`T`	`element()`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`protected org.gridgain.grid.kernal.processors.cache.datastructures.GridCacheQueueItemKey`	`itemKey(Long idx)`
`Iterator<T>`	`iterator()`
`String`	`name()` Gets queue name.
`boolean`	`offer(T item, long timeout, TimeUnit unit)`
`T`	`peek()`
`T`	`poll(long timeout, TimeUnit unit)`
`void`	`put(T item)`
`int`	`remainingCapacity()`
`T`	`remove()`
`boolean`	`removed()` Gets status of queue.
`protected abstract void`	`removeItem(long rmvIdx)` Removes item with given index from queue.
`int`	`size()`
`T`	`take()`
`String`	`toString()`

Methods inherited from class java.util.AbstractCollection
addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gridgain.grid.cache.datastructures.GridCacheQueue
addAll, clear, contains, containsAll, isEmpty, offer, poll, remove, removeAll, retainAll, toArray, toArray

- Field Detail
  - QUEUE_REMOVED_IDX
```
protected static final long QUEUE_REMOVED_IDX
```
    Value returned by closure updating queue header indicating that queue was removed.
    
    See Also:
    Constant Field Values
  - MAX_UPDATE_RETRIES
```
protected static final int MAX_UPDATE_RETRIES
```
    See Also:
    Constant Field Values
  - RETRY_DELAY
```
protected static final long RETRY_DELAY
```
    See Also:
    Constant Field Values
  - log
```
protected final GridLogger log
```
    Logger.
  - cctx
```
protected final GridCacheContext<?,?> cctx
```
    Cache context.
  - cache
```
protected final GridCacheAdapter cache
```
    Cache.
  - queueName
```
protected final String queueName
```
    Queue name.
  - queueKey
```
protected final GridCacheQueueHeaderKey queueKey
```
    Queue header key.
  - id
```
protected final GridUuid id
```
    Queue unique ID.
- Constructor Detail
  - GridCacheQueueAdapter
```
protected GridCacheQueueAdapter(String queueName,
                     GridCacheQueueHeader hdr,
                     GridCacheContext<?,?> cctx)
```
    Parameters:
    queueName - Queue name.
    hdr - Queue hdr.
    cctx - Cache context.
- Method Detail
  - name
```
public String name()
```
    Gets queue name.
    
    Specified by:
    
    name in interface GridCacheQueue<T>
    
    Returns:
    Queue name.
  - add
```
public boolean add(T item)
```
    Specified by:
    
    add in interface Collection<T>
    
    Specified by:
    
    add in interface BlockingQueue<T>
    
    Specified by:
    
    add in interface Queue<T>
    
    Specified by:
    
    add in interface GridCacheQueue<T>
    
    Overrides:
    
    add in class AbstractCollection<T>
  - collocated
```
public boolean collocated()
```
    Returns true if this queue can be kept on the one node only. Returns false if this queue can be kept on the many nodes.
    
    Specified by:
    
    collocated in interface GridCacheQueue<T>
    
    Returns:
    true if this queue is in collocated mode false otherwise.
  - capacity
```
public int capacity()
             throws GridException
```
    Gets maximum number of elements of the queue.
    
    Specified by:
    
    capacity in interface GridCacheQueue<T>
    
    Returns:
    Maximum number of elements. If queue is unbounded Integer.MAX_SIZE will return.
    
    Throws:
    
    GridException - If operation failed.
  - bounded
```
public boolean bounded()
```
    Returns true if this queue is bounded.
    
    Specified by:
    
    bounded in interface GridCacheQueue<T>
    
    Returns:
    true if this queue is bounded.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<T>
    
    Specified by:
    
    size in interface GridCacheQueue<T>
    
    Specified by:
    
    size in class AbstractCollection<T>
  - peek
```
@Nullable
public T peek()
       throws GridRuntimeException
```
    Specified by:
    
    peek in interface Queue<T>
    
    Specified by:
    
    peek in interface GridCacheQueue<T>
    
    Throws:
    
    GridRuntimeException
  - remove
```
public T remove()
```
    Specified by:
    
    remove in interface Queue<T>
  - element
```
public T element()
```
    Specified by:
    
    element in interface Queue<T>
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface Collection<T>
    
    Specified by:
    
    iterator in interface GridCacheQueue<T>
    
    Specified by:
    
    iterator in class AbstractCollection<T>
  - put
```
public void put(T item)
         throws GridRuntimeException
```
    Specified by:
    
    put in interface BlockingQueue<T>
    
    Specified by:
    
    put in interface GridCacheQueue<T>
    
    Throws:
    
    GridRuntimeException
  - offer
```
public boolean offer(T item,
            long timeout,
            TimeUnit unit)
              throws GridRuntimeException
```
    Specified by:
    
    offer in interface BlockingQueue<T>
    
    Specified by:
    
    offer in interface GridCacheQueue<T>
    
    Throws:
    
    GridRuntimeException
  - take
```
@Nullable
public T take()
       throws GridRuntimeException
```
    Specified by:
    
    take in interface BlockingQueue<T>
    
    Specified by:
    
    take in interface GridCacheQueue<T>
    
    Throws:
    
    GridRuntimeException
  - poll
```
@Nullable
public T poll(long timeout,
              TimeUnit unit)
       throws GridRuntimeException
```
    Specified by:
    
    poll in interface BlockingQueue<T>
    
    Specified by:
    
    poll in interface GridCacheQueue<T>
    
    Throws:
    
    GridRuntimeException
  - remainingCapacity
```
public int remainingCapacity()
```
    Specified by:
    
    remainingCapacity in interface BlockingQueue<T>
  - clear
```
public void clear(int batchSize)
           throws GridRuntimeException
```
    Removes all of the elements from this queue. Method is used in massive queues with huge numbers of elements.
    
    Specified by:
    
    clear in interface GridCacheQueue<T>
    
    Parameters:
    batchSize - Batch size.
    
    Throws:
    
    GridRuntimeException - if operation failed.
  - drainTo
```
public int drainTo(Collection<? super T> c)
```
    Specified by:
    
    drainTo in interface BlockingQueue<T>
  - drainTo
```
public int drainTo(Collection<? super T> c,
          int maxElements)
```
    Specified by:
    
    drainTo in interface BlockingQueue<T>
  - removed
```
public boolean removed()
```
    Gets status of queue.
    
    Specified by:
    
    removed in interface GridCacheQueue<T>
    
    Returns:
    true if queue was removed from cache false otherwise.
  - checkRemoved
```
protected final void checkRemoved(Long idx)
```
    Checks result of closure modifying queue header, throws GridCacheDataStructureRemovedRuntimeException if queue was removed.
    
    Parameters:
    idx - Result of closure execution.
  - checkRemoved
```
protected final void checkRemoved(@Nullable
                GridCacheQueueHeader hdr)
```
    Checks queue state, throws GridCacheDataStructureRemovedRuntimeException if queue was removed.
    
    Parameters:
    hdr - Queue hdr.
  - removeItem
```
protected abstract void removeItem(long rmvIdx)
                            throws GridException
```
    Removes item with given index from queue.
    
    Parameters:
    rmvIdx - Index of item to be removed.
    
    Throws:
    
    GridException - If failed.
  - itemKey
```
protected org.gridgain.grid.kernal.processors.cache.datastructures.GridCacheQueueItemKey itemKey(Long idx)
```
    Parameters:
    idx - Item index.
    
    Returns:
    Item key.
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<T>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<T>
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractCollection<T>

Class GridCacheQueueAdapter<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface org.gridgain.grid.cache.datastructures.GridCacheQueue

Field Detail

QUEUE_REMOVED_IDX

MAX_UPDATE_RETRIES

RETRY_DELAY

log

cctx

cache

queueName

queueKey

id

Constructor Detail

GridCacheQueueAdapter

Method Detail

name

add

collocated

capacity

bounded

size

peek

remove

element

iterator

put

offer

take

poll

remainingCapacity

clear

drainTo

drainTo

removed

checkRemoved

checkRemoved

removeItem

itemKey

equals

hashCode

toString