Java Doc for BlockingQueue.java in  » Apache-Harmony-Java-SE » java-package » java » util » concurrent » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Apache Harmony Java SE » java package » java.util.concurrent 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.concurrent.BlockingQueue

BlockingQueue
public interface BlockingQueue extends Queue<E>(Code)
A java.util.Queue that additionally supports operations that wait for the queue to become non-empty when retrieving an element, and wait for space to become available in the queue when storing an element.

A BlockingQueue does not accept null elements. Implementations throw NullPointerException on attempts to add, put or offer a null. A null is used as a sentinel value to indicate failure of poll operations.

A BlockingQueue may be capacity bounded. At any given time it may have a remainingCapacity beyond which no additional elements can be put without blocking. A BlockingQueue without any intrinsic capacity constraints always reports a remaining capacity of Integer.MAX_VALUE.

While BlockingQueue is designed to be used primarily for producer-consumer queues, it additionally supports the java.util.Collection interface. So, for example, it is possible to remove an arbitrary element from a queue using remove(x). However, such operations are in general not performed very efficiently, and are intended for only occasional use, such as when a queued message is cancelled. Also, the bulk Collection operations, most notably addAll, are not necessarily performed atomically, so it is possible for addAll(c) to fail (throwing an exception) after adding only some of the elements in c.

A BlockingQueue does not intrinsically support any kind of "close" or "shutdown" operation to indicate that no more items will be added. The needs and usage of such features tend to be implementation-dependent. For example, a common tactic is for producers to insert special end-of-stream or poison objects, that are interpreted accordingly when taken by consumers.

Usage example, based on a typical producer-consumer scenario. Note that a BlockingQueue can safely be used with multiple producers and multiple consumers.

 class Producer implements Runnable {
 private final BlockingQueue queue;
 Producer(BlockingQueue q) { queue = q; }
 public void run() {
 try {
 while(true) { queue.put(produce()); }
 } catch (InterruptedException ex) { ... handle ...}
 }
 Object produce() { ... }
 }
 class Consumer implements Runnable {
 private final BlockingQueue queue;
 Consumer(BlockingQueue q) { queue = q; }
 public void run() {
 try {
 while(true) { consume(queue.take()); }
 } catch (InterruptedException ex) { ... handle ...}
 }
 void consume(Object x) { ... }
 }
 class Setup {
 void main() {
 BlockingQueue q = new SomeQueueImplementation();
 Producer p = new Producer(q);
 Consumer c1 = new Consumer(q);
 Consumer c2 = new Consumer(q);
 new Thread(p).start();
 new Thread(c1).start();
 new Thread(c2).start();
 }
 }
 

This interface is a member of the Java Collections Framework.
since:
   1.5
author:
   Doug Lea<
Parameters:
  E - > the type of elements held in this collection





Method Summary
 booleanadd(E o)
     Adds the specified element to this queue if it is possible to do so immediately, returning true upon success, else throwing an IllegalStateException.
 intdrainTo(Collection<? super E> c)
     Removes all available elements from this queue and adds them into the given collection.
 intdrainTo(Collection<? super E> c, int maxElements)
     Removes at most the given number of available elements from this queue and adds them into the given collection.
 booleanoffer(E o)
     Inserts the specified element into this queue, if possible.
 booleanoffer(E o, long timeout, TimeUnit unit)
     Inserts the specified element into this queue, waiting if necessary up to the specified wait time for space to become available.
 Epoll(long timeout, TimeUnit unit)
     Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time if no elements are present on this queue.
 voidput(E o)
     Adds the specified element to this queue, waiting if necessary for space to become available.
 intremainingCapacity()
     Returns the number of 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.
 Etake()
     Retrieves and removes the head of this queue, waiting if no elements are present on this queue.



Method Detail
add
boolean add(E o)(Code)
Adds the specified element to this queue if it is possible to do so immediately, returning true upon success, else throwing an IllegalStateException.
Parameters:
  o - the element true (as per the general contract ofCollection.add).
throws:
  NullPointerException - if the specified element is null
throws:
  IllegalStateException - if element cannot be added



drainTo
int drainTo(Collection<? super E> c)(Code)
Removes all available elements from this queue and adds them into 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 IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
Parameters:
  c - the collection to transfer elements into the number of elements transferred.
throws:
  NullPointerException - if c is null
throws:
  IllegalArgumentException - if c is this queue



drainTo
int drainTo(Collection<? super E> c, int maxElements)(Code)
Removes at most the given number of available elements from this queue and adds them into the given collection. 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 IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
Parameters:
  c - the collection to transfer elements into
Parameters:
  maxElements - the maximum number of elements to transfer the number of elements transferred.
throws:
  NullPointerException - if c is null
throws:
  IllegalArgumentException - if c is this queue



offer
boolean offer(E o)(Code)
Inserts the specified element into this queue, if possible. When using queues that may impose insertion restrictions (for example capacity bounds), method offer is generally preferable to method Collection.add , which can fail to insert an element only by throwing an exception.
Parameters:
  o - the element to add. true if it was possible to add the element tothis queue, else false
throws:
  NullPointerException - if the specified element is null



offer
boolean offer(E o, long timeout, TimeUnit unit) throws InterruptedException(Code)
Inserts the specified element into this queue, waiting if necessary up to the specified wait time for space to become available.
Parameters:
  o - the element to add
Parameters:
  timeout - how long to wait before giving up, in units ofunit
Parameters:
  unit - a TimeUnit determining how to interpret thetimeout parameter true if successful, or false ifthe specified waiting time elapses before space is available.
throws:
  InterruptedException - if interrupted while waiting.
throws:
  NullPointerException - if the specified element is null.



poll
E poll(long timeout, TimeUnit unit) throws InterruptedException(Code)
Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time if no elements are present on this queue.
Parameters:
  timeout - how long to wait before giving up, in units ofunit
Parameters:
  unit - a TimeUnit determining how to interpret thetimeout parameter the head of this queue, or null if thespecified waiting time elapses before an element is present.
throws:
  InterruptedException - if interrupted while waiting.



put
void put(E o) throws InterruptedException(Code)
Adds the specified element to this queue, waiting if necessary for space to become available.
Parameters:
  o - the element to add
throws:
  InterruptedException - if interrupted while waiting.
throws:
  NullPointerException - if the specified element is null.



remainingCapacity
int remainingCapacity()(Code)
Returns the number of 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 add an element will succeed by inspecting remainingCapacity because it may be the case that a waiting consumer is ready to take an element out of an otherwise full queue. the remaining capacity




take
E take() throws InterruptedException(Code)
Retrieves and removes the head of this queue, waiting if no elements are present on this queue. the head of this queue
throws:
  InterruptedException - if interrupted while waiting.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.