Packages

c

akka.dispatch.forkjoin

LinkedTransferQueue

class LinkedTransferQueue[E] extends AbstractQueue[E] with TransferQueue[E] with Serializable

An unbounded TransferQueue based on linked nodes. This queue orders elements FIFO (first-in-first-out) with respect to any given producer. The head of the queue is that element that has been on the queue the longest time for some producer. The tail of the queue is that element that has been on the queue the shortest time for some producer.

Beware that, unlike in most collections, the size method is NOT a constant-time operation. Because of the asynchronous nature of these queues, determining the current number of elements requires a traversal of the elements, and so may report inaccurate results if this collection is modified during traversal. Additionally, the bulk operations addAll, removeAll, retainAll, containsAll, equals, and toArray are not guaranteed to be performed atomically. For example, an iterator operating concurrently with an addAll operation might view only some of the added elements.

This class and its iterator implement all of the optional methods of the Collection and Iterator interfaces.

Memory consistency effects: As with other concurrent collections, actions in a thread prior to placing an object into a LinkedTransferQueue happen-before actions subsequent to the access or removal of that element from the LinkedTransferQueue in another thread.

This class is a member of the Java Collections Framework.

Source
LinkedTransferQueue.java
Since

1.7

Linear Supertypes
Serializable, TransferQueue[E], BlockingQueue[E], AbstractQueue[E], Queue[E], AbstractCollection[E], Collection[E], Iterable[E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LinkedTransferQueue
  2. Serializable
  3. TransferQueue
  4. BlockingQueue
  5. AbstractQueue
  6. Queue
  7. AbstractCollection
  8. Collection
  9. Iterable
  10. AnyRef
  11. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LinkedTransferQueue(c: Collection[_ <: E])

    Creates a LinkedTransferQueue initially containing the elements of the given collection, added in traversal order of the collection's iterator.

    Creates a LinkedTransferQueue initially containing the elements of the given collection, added in traversal order of the collection's iterator.

    c

    the collection of elements to initially contain

    Exceptions thrown

    NullPointerException if the specified collection or any of its elements are null

  2. new LinkedTransferQueue()

Value Members

  1. def add(e: E): Boolean

    Inserts the specified element at the tail of this queue.

    Inserts the specified element at the tail of this queue. As the queue is unbounded, this method will never throw IllegalStateException or return false.

    returns

    true (as specified by Collection#add)

    Definition Classes
    LinkedTransferQueue → BlockingQueue → AbstractQueue → Queue → AbstractCollection → Collection
    Exceptions thrown

    NullPointerException if the specified element is null

  2. def addAll(arg0: Collection[_ <: E]): Boolean
    Definition Classes
    AbstractQueue → AbstractCollection → Collection
  3. def clear(): Unit
    Definition Classes
    AbstractQueue → AbstractCollection → Collection
  4. def contains(o: Any): Boolean

    Returns true if this queue contains the specified element.

    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 o.equals(e).

    o

    object to be checked for containment in this queue

    returns

    true if this queue contains the specified element

    Definition Classes
    LinkedTransferQueue → BlockingQueue → AbstractCollection → Collection
  5. def containsAll(arg0: Collection[_]): Boolean
    Definition Classes
    AbstractCollection → Collection
  6. def drainTo(c: Collection[_ >: E], maxElements: Int): Int

    Definition Classes
    LinkedTransferQueue → BlockingQueue
    Exceptions thrown

    IllegalArgumentException <invalid inheritdoc annotation>

    NullPointerException <invalid inheritdoc annotation>

  7. def drainTo(c: Collection[_ >: E]): Int

    Definition Classes
    LinkedTransferQueue → BlockingQueue
    Exceptions thrown

    IllegalArgumentException <invalid inheritdoc annotation>

    NullPointerException <invalid inheritdoc annotation>

  8. def element(): E
    Definition Classes
    AbstractQueue → Queue
  9. def forEach(arg0: Consumer[_ >: E]): Unit
    Definition Classes
    Iterable
  10. def getWaitingConsumerCount(): Int

    Returns an estimate of the number of consumers waiting to receive elements via #take or timed poll.

    Returns an estimate of the number of consumers waiting to receive elements via #take or timed poll. The return value is an approximation of a momentary state of affairs, that may be inaccurate if consumers have completed or given up waiting. The value may be useful for monitoring and heuristics, but not for synchronization control. Implementations of this method are likely to be noticeably slower than those for #hasWaitingConsumer.

    returns

    the number of consumers waiting to receive elements

    Definition Classes
    LinkedTransferQueue → TransferQueue
  11. def hasWaitingConsumer(): Boolean

    Returns true if there is at least one consumer waiting to receive an element via #take or timed poll.

    Returns true if there is at least one consumer waiting to receive an element via #take or timed poll. The return value represents a momentary state of affairs.

    returns

    true if there is at least one waiting consumer

    Definition Classes
    LinkedTransferQueue → TransferQueue
  12. def isEmpty(): Boolean

    Returns true if this queue contains no elements.

    Returns true if this queue contains no elements.

    returns

    true if this queue contains no elements

    Definition Classes
    LinkedTransferQueue → AbstractCollection → Collection
  13. def iterator(): Iterator[E]

    Returns an iterator over the elements in this queue in proper sequence.

    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 a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

    returns

    an iterator over the elements in this queue in proper sequence

    Definition Classes
    LinkedTransferQueue → AbstractCollection → Collection → Iterable
  14. def offer(e: E): Boolean

    Inserts the specified element at the tail of this queue.

    Inserts the specified element at the tail of this queue. As the queue is unbounded, this method will never return false.

    returns

    true (as specified by Queue#offer)

    Definition Classes
    LinkedTransferQueue → BlockingQueue → Queue
    Exceptions thrown

    NullPointerException if the specified element is null

  15. def offer(e: E, timeout: Long, unit: TimeUnit): Boolean

    Inserts the specified element at the tail of this queue.

    Inserts the specified element at the tail of this queue. As the queue is unbounded, this method will never block or return false.

    returns

    true (as specified by BlockingQueue.offer)

    Definition Classes
    LinkedTransferQueue → BlockingQueue
    Exceptions thrown

    NullPointerException if the specified element is null

  16. def parallelStream(): Stream[E]
    Definition Classes
    Collection
  17. def peek(): E
    Definition Classes
    LinkedTransferQueue → Queue
  18. def poll(): E
    Definition Classes
    LinkedTransferQueue → Queue
  19. def poll(timeout: Long, unit: TimeUnit): E
    Definition Classes
    LinkedTransferQueue → BlockingQueue
  20. def put(e: E): Unit

    Inserts the specified element at the tail of this queue.

    Inserts the specified element at the tail of this queue. As the queue is unbounded, this method will never block.

    Definition Classes
    LinkedTransferQueue → BlockingQueue
    Exceptions thrown

    NullPointerException if the specified element is null

  21. def remainingCapacity(): Int

    Always returns Integer.MAX_VALUE because a LinkedTransferQueue is not capacity constrained.

    Always returns Integer.MAX_VALUE because a LinkedTransferQueue is not capacity constrained.

    returns

    Integer.MAX_VALUE (as specified by BlockingQueue.remainingCapacity)

    Definition Classes
    LinkedTransferQueue → BlockingQueue
  22. def remove(o: Any): Boolean

    Removes a single instance of the specified element from this queue, if it is present.

    Removes a single instance of the specified element from this queue, if it is present. More formally, removes an element e such that o.equals(e), if this queue contains one or more such elements. Returns true if this queue contained the specified element (or equivalently, if this queue changed as a result of the call).

    o

    element to be removed from this queue, if present

    returns

    true if this queue changed as a result of the call

    Definition Classes
    LinkedTransferQueue → BlockingQueue → AbstractCollection → Collection
  23. def remove(): E
    Definition Classes
    AbstractQueue → Queue
  24. def removeAll(arg0: Collection[_]): Boolean
    Definition Classes
    AbstractCollection → Collection
  25. def removeIf(arg0: Predicate[_ >: E]): Boolean
    Definition Classes
    Collection
  26. def retainAll(arg0: Collection[_]): Boolean
    Definition Classes
    AbstractCollection → Collection
  27. def size(): Int

    Returns the number of elements in this queue.

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

    Beware that, unlike in most collections, this method is NOT a constant-time operation. Because of the asynchronous nature of these queues, determining the current number of elements requires an O(n) traversal.

    returns

    the number of elements in this queue

    Definition Classes
    LinkedTransferQueue → AbstractCollection → Collection
  28. def spliterator(): Spliterator[E]
    Definition Classes
    Collection → Iterable
  29. def stream(): Stream[E]
    Definition Classes
    Collection
  30. def take(): E
    Definition Classes
    LinkedTransferQueue → BlockingQueue
  31. def toArray[T](arg0: Array[T]): Array[T]
    Definition Classes
    AbstractCollection → Collection
  32. def toArray(): Array[AnyRef]
    Definition Classes
    AbstractCollection → Collection
  33. def toArray[T](arg0: IntFunction[Array[T]]): Array[T]
    Definition Classes
    Collection
  34. def toString(): String
    Definition Classes
    AbstractCollection → AnyRef → Any
  35. def transfer(e: E): Unit

    Transfers the element to a consumer, waiting if necessary to do so.

    Transfers the element to a consumer, waiting if necessary to do so.

    More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in #take or timed poll), else inserts the specified element at the tail of this queue and waits until the element is received by a consumer.

    e

    the element to transfer

    Definition Classes
    LinkedTransferQueue → TransferQueue
    Exceptions thrown

    NullPointerException if the specified element is null

  36. def tryTransfer(e: E, timeout: Long, unit: TimeUnit): Boolean

    Transfers the element to a consumer if it is possible to do so before the timeout elapses.

    Transfers the element to a consumer if it is possible to do so before the timeout elapses.

    More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in #take or timed poll), else inserts the specified element at the tail of this queue and waits until the element is received by a consumer, returning false if the specified wait time elapses before the element can be transferred.

    e

    the element to transfer

    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 completion, in which case the element is not left enqueued

    Definition Classes
    LinkedTransferQueue → TransferQueue
    Exceptions thrown

    NullPointerException if the specified element is null

  37. def tryTransfer(e: E): Boolean

    Transfers the element to a waiting consumer immediately, if possible.

    Transfers the element to a waiting consumer immediately, if possible.

    More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in #take or timed poll), otherwise returning false without enqueuing the element.

    e

    the element to transfer

    returns

    true if the element was transferred, else false

    Definition Classes
    LinkedTransferQueue → TransferQueue
    Exceptions thrown

    NullPointerException if the specified element is null