Java Doc for LinkedBlockingDeque.java in  » 6.0-JDK-Core » Collections-Jar-Zip-Logging-regex » java » util » concurrent » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
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
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » Collections Jar Zip Logging regex » java.util.concurrent 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.concurrent.LinkedBlockingDeque

LinkedBlockingDeque
public class LinkedBlockingDeque extends AbstractQueue implements BlockingDeque<E>,java.io.Serializable(Code)
An optionally-bounded based on linked nodes.

The optional capacity bound constructor argument serves as a way to prevent excessive expansion. The capacity, if unspecified, is equal to Integer.MAX_VALUE . Linked nodes are dynamically created upon each insertion unless this would bring the deque above capacity.

Most operations run in constant time (ignoring time spent blocking). Exceptions include LinkedBlockingDeque.remove(Object) remove , LinkedBlockingDeque.removeFirstOccurrence removeFirstOccurrence , LinkedBlockingDeque.removeLastOccurrence removeLastOccurrence , LinkedBlockingDeque.containscontains , LinkedBlockingDeque.iterator iterator.remove() , and the bulk operations, all of which run in linear time.

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

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


Inner Class :final static class Node


Constructor Summary
public  LinkedBlockingDeque()
     Creates a LinkedBlockingDeque with a capacity of Integer.MAX_VALUE .
public  LinkedBlockingDeque(int capacity)
     Creates a LinkedBlockingDeque with the given (fixed) capacity.
public  LinkedBlockingDeque(Collection<? extends E> c)
     Creates a LinkedBlockingDeque with a capacity of Integer.MAX_VALUE , initially containing the elements of the given collection, added in traversal order of the collection's iterator.

Method Summary
public  booleanadd(E e)
     Inserts the specified element at the end of this deque unless it would violate capacity restrictions.
public  voidaddFirst(E e)
    
public  voidaddLast(E e)
    
public  voidclear()
     Atomically removes all of the elements from this deque.
public  booleancontains(Object o)
     Returns true if this deque contains the specified element.
public  Iterator<E>descendingIterator()
     Returns an iterator over the elements in this deque in reverse sequential order.
public  intdrainTo(Collection<? super E> c)
    
public  intdrainTo(Collection<? super E> c, int maxElements)
    
public  Eelement()
     Retrieves, but does not remove, the head of the queue represented by this deque.
public  EgetFirst()
    
public  EgetLast()
    
public  Iterator<E>iterator()
     Returns an iterator over the elements in this deque in proper sequence.
public  booleanoffer(E e)
    
public  booleanoffer(E e, long timeout, TimeUnit unit)
    
public  booleanofferFirst(E e)
    
public  booleanofferFirst(E e, long timeout, TimeUnit unit)
    
public  booleanofferLast(E e)
    
public  booleanofferLast(E e, long timeout, TimeUnit unit)
    
public  Epeek()
    
public  EpeekFirst()
    
public  EpeekLast()
    
public  Epoll()
    
public  Epoll(long timeout, TimeUnit unit)
    
public  EpollFirst()
    
public  EpollFirst(long timeout, TimeUnit unit)
    
public  EpollLast()
    
public  EpollLast(long timeout, TimeUnit unit)
    
public  Epop()
    
public  voidpush(E e)
    
public  voidput(E e)
    
public  voidputFirst(E e)
    
public  voidputLast(E e)
    
public  intremainingCapacity()
     Returns the number of additional elements that this deque can ideally (in the absence of memory or resource constraints) accept without blocking.
public  Eremove()
     Retrieves and removes the head of the queue represented by this deque.
public  booleanremove(Object o)
     Removes the first occurrence of the specified element from this deque.
public  EremoveFirst()
    
public  booleanremoveFirstOccurrence(Object o)
    
public  EremoveLast()
    
public  booleanremoveLastOccurrence(Object o)
    
 booleanremoveNode(Node<E> e)
     Variant of removeFirstOccurrence needed by iterator.remove.
public  intsize()
     Returns the number of elements in this deque.
public  Etake()
    
public  EtakeFirst()
    
public  EtakeLast()
    
public  Object[]toArray()
     Returns an array containing all of the elements in this deque, in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this deque.

public  T[]toArray(T[] a)
     Returns an array containing all of the elements in this deque, in proper sequence; the runtime type of the returned array is that of the specified array.
public  StringtoString()
    


Constructor Detail
LinkedBlockingDeque
public LinkedBlockingDeque()(Code)
Creates a LinkedBlockingDeque with a capacity of Integer.MAX_VALUE .



LinkedBlockingDeque
public LinkedBlockingDeque(int capacity)(Code)
Creates a LinkedBlockingDeque with the given (fixed) capacity.
Parameters:
  capacity - the capacity of this deque
throws:
  IllegalArgumentException - if capacity is less than 1



LinkedBlockingDeque
public LinkedBlockingDeque(Collection<? extends E> c)(Code)
Creates a LinkedBlockingDeque with a capacity of Integer.MAX_VALUE , initially containing the elements of the given collection, added in traversal order of the collection's iterator.
Parameters:
  c - the collection of elements to initially contain
throws:
  NullPointerException - if the specified collection or anyof its elements are null




Method Detail
add
public boolean add(E e)(Code)
Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, it is generally preferable to use method LinkedBlockingDeque.offer(Object) offer .

This method is equivalent to LinkedBlockingDeque.addLast .
throws:
  IllegalStateException - if the element cannot be added at thistime due to capacity restrictions
throws:
  NullPointerException - if the specified element is null




addFirst
public void addFirst(E e)(Code)

throws:
  IllegalStateException -
throws:
  NullPointerException -



addLast
public void addLast(E e)(Code)

throws:
  IllegalStateException -
throws:
  NullPointerException -



clear
public void clear()(Code)
Atomically removes all of the elements from this deque. The deque will be empty after this call returns.



contains
public boolean contains(Object o)(Code)
Returns true if this deque contains the specified element. More formally, returns true if and only if this deque contains at least one element e such that o.equals(e).
Parameters:
  o - object to be checked for containment in this deque true if this deque contains the specified element



descendingIterator
public Iterator<E> descendingIterator()(Code)
Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head). 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.



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

throws:
  UnsupportedOperationException -
throws:
  ClassCastException -
throws:
  NullPointerException -
throws:
  IllegalArgumentException -



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

throws:
  UnsupportedOperationException -
throws:
  ClassCastException -
throws:
  NullPointerException -
throws:
  IllegalArgumentException -



element
public E element()(Code)
Retrieves, but does not remove, the head of the queue represented by this deque. This method differs from LinkedBlockingDeque.peek peek only in that it throws an exception if this deque is empty.

This method is equivalent to LinkedBlockingDeque.getFirst() getFirst . the head of the queue represented by this deque
throws:
  NoSuchElementException - if this deque is empty




getFirst
public E getFirst()(Code)

throws:
  NoSuchElementException -



getLast
public E getLast()(Code)

throws:
  NoSuchElementException -



iterator
public Iterator<E> iterator()(Code)
Returns an iterator over the elements in this deque 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. an iterator over the elements in this deque in proper sequence



offer
public boolean offer(E e)(Code)

throws:
  NullPointerException - if the specified element is null



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

throws:
  NullPointerException -
throws:
  InterruptedException -



offerFirst
public boolean offerFirst(E e)(Code)

throws:
  NullPointerException -



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

throws:
  NullPointerException -
throws:
  InterruptedException -



offerLast
public boolean offerLast(E e)(Code)

throws:
  NullPointerException -



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

throws:
  NullPointerException -
throws:
  InterruptedException -



peek
public E peek()(Code)



peekFirst
public E peekFirst()(Code)



peekLast
public E peekLast()(Code)



poll
public E poll()(Code)



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



pollFirst
public E pollFirst()(Code)



pollFirst
public E pollFirst(long timeout, TimeUnit unit) throws InterruptedException(Code)



pollLast
public E pollLast()(Code)



pollLast
public E pollLast(long timeout, TimeUnit unit) throws InterruptedException(Code)



pop
public E pop()(Code)

throws:
  NoSuchElementException -



push
public void push(E e)(Code)

throws:
  IllegalStateException -
throws:
  NullPointerException -



put
public void put(E e) throws InterruptedException(Code)

throws:
  NullPointerException -
throws:
  InterruptedException -



putFirst
public void putFirst(E e) throws InterruptedException(Code)

throws:
  NullPointerException -
throws:
  InterruptedException -



putLast
public void putLast(E e) throws InterruptedException(Code)

throws:
  NullPointerException -
throws:
  InterruptedException -



remainingCapacity
public int remainingCapacity()(Code)
Returns the number of additional elements that this deque can ideally (in the absence of memory or resource constraints) accept without blocking. This is always equal to the initial capacity of this deque less the current size of this deque.

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.




remove
public E remove()(Code)
Retrieves and removes the head of the queue represented by this deque. This method differs from LinkedBlockingDeque.poll poll only in that it throws an exception if this deque is empty.

This method is equivalent to LinkedBlockingDeque.removeFirst() removeFirst . the head of the queue represented by this deque
throws:
  NoSuchElementException - if this deque is empty




remove
public boolean remove(Object o)(Code)
Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that o.equals(e) (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

This method is equivalent to LinkedBlockingDeque.removeFirstOccurrence(Object) removeFirstOccurrence .
Parameters:
  o - element to be removed from this deque, if present true if this deque changed as a result of the call




removeFirst
public E removeFirst()(Code)

throws:
  NoSuchElementException -



removeFirstOccurrence
public boolean removeFirstOccurrence(Object o)(Code)



removeLast
public E removeLast()(Code)

throws:
  NoSuchElementException -



removeLastOccurrence
public boolean removeLastOccurrence(Object o)(Code)



removeNode
boolean removeNode(Node<E> e)(Code)
Variant of removeFirstOccurrence needed by iterator.remove. Searches for the node, not its contents.



size
public int size()(Code)
Returns the number of elements in this deque. the number of elements in this deque



take
public E take() throws InterruptedException(Code)



takeFirst
public E takeFirst() throws InterruptedException(Code)



takeLast
public E takeLast() throws InterruptedException(Code)



toArray
public Object[] toArray()(Code)
Returns an array containing all of the elements in this deque, in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this deque. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs. an array containing all of the elements in this deque




toArray
public T[] toArray(T[] a)(Code)
Returns an array containing all of the elements in this deque, in proper sequence; the runtime type of the returned array is that of the specified array. If the deque fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this deque.

If this deque fits in the specified array with room to spare (i.e., the array has more elements than this deque), the element in the array immediately following the end of the deque is set to null.

Like the LinkedBlockingDeque.toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a deque known to contain only strings. The following code can be used to dump the deque into a newly allocated array of String:

 String[] y = x.toArray(new String[0]);
Note that toArray(new Object[0]) is identical in function to toArray().
Parameters:
  a - the array into which the elements of the deque are tobe stored, if it is big enough; otherwise, a new array of thesame runtime type is allocated for this purpose an array containing all of the elements in this deque
throws:
  ArrayStoreException - if the runtime type of the specified arrayis not a supertype of the runtime type of every element inthis deque
throws:
  NullPointerException - if the specified array is null



toString
public String toString()(Code)



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