com.hazelcast.client.proxy
Class ClientQueueProxy<E>

java.lang.Object
  com.hazelcast.client.spi.ClientProxy
      com.hazelcast.client.proxy.ClientQueueProxy<E>

All Implemented Interfaces:

BaseQueue<E>, DistributedObject, ICollection<E>, IQueue<E>, Iterable<E>, Collection<E>, BlockingQueue<E>, Queue<E>

public final class ClientQueueProxy<E>
extends ClientProxy
implements IQueue<E>

Author:

ali 5/19/13

Constructor Summary

ClientQueueProxy(String serviceName, String name)

Method Summary

boolean	add(E e)
boolean	addAll(Collection<? extends E> c)
String	addItemListener(ItemListener<E> listener, boolean includeValue)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
int	drainTo(Collection<? super E> objects)
int	drainTo(Collection<? super E> c, int maxElements)
E	element()
LocalQueueStats	getLocalQueueStats()
protected <T> T	invoke(ClientRequest req)
protected <T> T	invokeInterruptibly(ClientRequest req)
boolean	isEmpty()
Iterator<E>	iterator()
boolean	offer(E e) It is advised to use this method in a try-catch block to take the offer operation full lifecycle control, in a "lost node" scenario you can not be sure offer is succeeded or not so you may want to retry.
boolean	offer(E e, long timeout, TimeUnit unit)
E	peek()
E	poll()
E	poll(long timeout, TimeUnit unit)
void	put(E e)
int	remainingCapacity()
E	remove()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	removeItemListener(String registrationId)
boolean	retainAll(Collection<?> c)
int	size()
E	take()
Object[]	toArray()
<T> T[]	toArray(T[] ts)
String	toString()

Methods inherited from class com.hazelcast.client.spi.ClientProxy

destroy, equals, getContext, getId, getName, getPartitionKey, getServiceName, hashCode, invoke, invoke, invokeInterruptibly, listen, listen, onDestroy, onInitialize, onShutdown, setContext, stopListening, throwExceptionIfNull, toData, toObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Methods inherited from interface com.hazelcast.core.ICollection

getName

Methods inherited from interface com.hazelcast.core.DistributedObject

destroy, getId, getPartitionKey, getServiceName

Constructor Detail

ClientQueueProxy

public ClientQueueProxy(String serviceName,
                        String name)

Method Detail

addItemListener

public String addItemListener(ItemListener<E> listener,
                              boolean includeValue)

Specified by:

addItemListener in interface ICollection<E>

removeItemListener

public boolean removeItemListener(String registrationId)

Specified by:

removeItemListener in interface ICollection<E>

getLocalQueueStats

public LocalQueueStats getLocalQueueStats()

Specified by:

getLocalQueueStats in interface IQueue<E>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface BlockingQueue<E>

Specified by:

add in interface Queue<E>

offer

public boolean offer(E e)

It is advised to use this method in a try-catch block to take the offer operation full lifecycle control, in a "lost node" scenario you can not be sure offer is succeeded or not so you may want to retry.

Specified by:

offer in interface BaseQueue<E>

Specified by:

offer in interface BlockingQueue<E>

Specified by:

offer in interface Queue<E>

Parameters:

e - the element to add

Returns:

true if the element was added to this queue. false if there is not enough capacity to insert the element.

Throws:

HazelcastException - if client loses the connected node.

put

public void put(E e)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<E>

Throws:

InterruptedException

offer

public boolean offer(E e,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BaseQueue<E>

Specified by:

offer in interface BlockingQueue<E>

Throws:

InterruptedException

take

public E take()
       throws InterruptedException

Specified by:

take in interface BaseQueue<E>

Specified by:

take in interface IQueue<E>

Specified by:

take in interface BlockingQueue<E>

Throws:

InterruptedException

poll

public E poll(long timeout,
              TimeUnit unit)
       throws InterruptedException

Specified by:

poll in interface BaseQueue<E>

Specified by:

poll in interface IQueue<E>

Specified by:

poll in interface BlockingQueue<E>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface BlockingQueue<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface BlockingQueue<E>

drainTo

public int drainTo(Collection<? super E> objects)

Specified by:

drainTo in interface BlockingQueue<E>

drainTo

public int drainTo(Collection<? super E> c,
                   int maxElements)

Specified by:

drainTo in interface BlockingQueue<E>

remove

public E remove()

Specified by:

remove in interface Queue<E>

poll

public E poll()

Specified by:

poll in interface BaseQueue<E>

Specified by:

poll in interface IQueue<E>

Specified by:

poll in interface Queue<E>

element

public E element()

Specified by:

element in interface Queue<E>

peek

public E peek()

Specified by:

peek in interface Queue<E>

size

public int size()

Specified by:

size in interface BaseQueue<E>

Specified by:

size in interface Collection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

toArray

public <T> T[] toArray(T[] ts)

Specified by:

toArray in interface Collection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

invoke

protected <T> T invoke(ClientRequest req)

Overrides:

invoke in class ClientProxy

invokeInterruptibly

protected <T> T invokeInterruptibly(ClientRequest req)
                         throws InterruptedException

Throws:

InterruptedException

toString

public String toString()

Overrides:

toString in class Object