lbmq

Class LinkedBlockingMultiQueue.SubQueue

java.lang.Object

java.util.AbstractCollection<E>

lbmq.AbstractOfferable<E>

lbmq.LinkedBlockingMultiQueue.SubQueue

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, Offerable<E>

Enclosing class:

LinkedBlockingMultiQueue<K,E>

public class LinkedBlockingMultiQueue.SubQueue
extends AbstractOfferable<E>

Represent a sub-queue inside a multi-queue. Instances of this class are just like any blocking queue except that elements cannot be taken from their heads.

Method Summary

Modifier and Type	Method and Description
void	clear() Atomically removes all of the elements from this queue.
boolean	contains(java.lang.Object o)
void	enable(boolean status) Enable or disable this sub-queue.
boolean	isEmpty() Return whether the queue is empty.
boolean	isEnabled() Returns whether this sub-queue is enabled
java.util.Iterator<E>	iterator() Returns an iterator over the elements in this queue in proper sequence.
boolean	offer(E e) Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.
boolean	offer(E e, long timeout, java.util.concurrent.TimeUnit unit) Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.
void	put(E e) Inserts the specified element into this queue, waiting if necessary for space to become available.
int	remainingCapacity() 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.
boolean	remove(java.lang.Object o)
int	size() Return the number of elements in this sub queue.
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	toString()

Methods inherited from class lbmq.AbstractOfferable

add, addAll

Methods inherited from class java.util.AbstractCollection

containsAll, removeAll, retainAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

remainingCapacity

public int remainingCapacity()

Description copied from interface: Offerable

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.

Returns:

the remaining capacity

clear

public void clear()

Atomically removes all of the elements from this queue. The queue will be empty after this call returns.

Specified by:

clear in interface java.util.Collection<E>

Overrides:

clear in class java.util.AbstractCollection<E>

enable

public void enable(boolean status)

Enable or disable this sub-queue. Enabled queues's elements are taken from the common head of the multi-queue. Elements from disabled queues are never taken. Elements can be added to a queue regardless of this status (if there is enough remaining capacity).

Parameters:

status - true to enable, false to disable

isEnabled

public boolean isEnabled()

Returns whether this sub-queue is enabled

Returns:

true is this sub-queue is enabled, false if is disabled.

size

public int size()

Return the number of elements in this sub queue. This method returns the actual number of elements, regardless of whether the queue is enabled or not.

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in class java.util.AbstractCollection<E>

isEmpty

public boolean isEmpty()

Return whether the queue is empty. This method bases its return value in the actual number of elements, regardless of whether the queue is enabled or not.

Specified by:

isEmpty in interface java.util.Collection<E>

Overrides:

isEmpty in class java.util.AbstractCollection<E>

put

public void put(E e)
         throws java.lang.InterruptedException

Description copied from interface: Offerable

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

Parameters:

e - the element to add

Throws:

java.lang.InterruptedException - if interrupted while waiting

offer

public boolean offer(E e,
                     long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Description copied from interface: Offerable

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

Parameters:

e - the element to add

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

true if successful, or false if the specified waiting time elapses before space is available

Throws:

java.lang.InterruptedException - if interrupted while waiting

offer

public boolean offer(E e)

Description copied from interface: Offerable

Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted queue, this method is generally preferable to Offerable.add(E), which can fail to insert an element only by throwing an exception.

Parameters:

e - the element to add

Returns:

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

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

Overrides:

remove in class java.util.AbstractCollection<E>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

Overrides:

contains in class java.util.AbstractCollection<E>

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Overrides:

toArray in class java.util.AbstractCollection<E>

toArray

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

Specified by:

toArray in interface java.util.Collection<E>

Overrides:

toArray in class java.util.AbstractCollection<E>

iterator

public java.util.Iterator<E> iterator()

Returns an iterator over the elements in this queue in proper sequence. The elements will be returned in order from first (head) to last (tail).

The returned iterator is weakly consistent.

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in class java.util.AbstractCollection<E>

Returns:

an iterator over the elements in this queue in proper sequence