commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r1725738 - /commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
Date Wed, 20 Jan 2016 15:20:09 GMT
Author: markt
Date: Wed Jan 20 15:20:09 2016
New Revision: 1725738

URL: http://svn.apache.org/viewvc?rev=1725738&view=rev
Log:
Fill some Javadoc gaps

Modified:
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java?rev=1725738&r1=1725737&r2=1725738&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
(original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
Wed Jan 20 15:20:09 2016
@@ -418,8 +418,9 @@ class LinkedBlockingDeque<E> extends Abs
      *
      * @param e element to link
      *
-     * @throws NullPointerException
-     * @throws InterruptedException
+     * @throws NullPointerException if e is null
+     * @throws InterruptedException if the thread is interrupted whilst waiting
+     *         for space
      */
     public void putFirst(E e) throws InterruptedException {
         if (e == null) {
@@ -441,8 +442,9 @@ class LinkedBlockingDeque<E> extends Abs
      *
      * @param e element to link
      *
-     * @throws NullPointerException
-     * @throws InterruptedException
+     * @throws NullPointerException if e is null
+     * @throws InterruptedException if the thread is interrupted whilst waiting
+     *         for space
      */
     public void putLast(E e) throws InterruptedException {
         if (e == null) {
@@ -468,8 +470,9 @@ class LinkedBlockingDeque<E> extends Abs
      *
      * @return {@code true} if successful, otherwise {@code false}
      *
-     * @throws NullPointerException
-     * @throws InterruptedException
+     * @throws NullPointerException if e is null
+     * @throws InterruptedException if the thread is interrupted whilst waiting
+     *         for space
      */
     public boolean offerFirst(E e, long timeout, TimeUnit unit)
         throws InterruptedException {
@@ -501,8 +504,9 @@ class LinkedBlockingDeque<E> extends Abs
      *
      * @return {@code true} if successful, otherwise {@code false}
      *
-     * @throws NullPointerException
-     * @throws InterruptedException
+     * @throws NullPointerException if e is null
+     * @throws InterruptedException if the thread is interrupted whist waiting
+     *         for space
      */
     public boolean offerLast(E e, long timeout, TimeUnit unit)
         throws InterruptedException {
@@ -773,8 +777,9 @@ class LinkedBlockingDeque<E> extends Abs
      *
      * @param e element to link
      *
-     * @throws NullPointerException
-     * @throws InterruptedException
+     * @throws NullPointerException if e is null
+     * @throws InterruptedException if the thread is interrupted whilst waiting
+     *         for space
      */
     public void put(E e) throws InterruptedException {
         putLast(e);
@@ -792,8 +797,9 @@ class LinkedBlockingDeque<E> extends Abs
      *
      * @return {@code true} if successful, otherwise {@code false}
      *
-     * @throws NullPointerException
-     * @throws InterruptedException
+     * @throws NullPointerException if e is null
+     * @throws InterruptedException if the thread is interrupted whilst waiting
+     *         for space
      */
     public boolean offer(E e, long timeout, TimeUnit unit)
         throws InterruptedException {
@@ -898,10 +904,13 @@ class LinkedBlockingDeque<E> extends Abs
      *
      * @return number of elements added to the collection
      *
-     * @throws UnsupportedOperationException
-     * @throws ClassCastException
-     * @throws NullPointerException
-     * @throws IllegalArgumentException
+     * @throws UnsupportedOperationException if the add operation is not
+     *         supported by the specified collection
+     * @throws ClassCastException if the class of the elements held by this
+     *         collection prevents them from being added to the specified
+     *         collection
+     * @throws NullPointerException if c is null
+     * @throws IllegalArgumentException if c is this instance
      */
     public int drainTo(Collection<? super E> c) {
         return drainTo(c, Integer.MAX_VALUE);
@@ -915,10 +924,13 @@ class LinkedBlockingDeque<E> extends Abs
      * @param maxElements maximum number of elements to remove from the queue
      *
      * @return number of elements added to the collection
-     * @throws UnsupportedOperationException
-     * @throws ClassCastException
-     * @throws NullPointerException
-     * @throws IllegalArgumentException
+     * @throws UnsupportedOperationException if the add operation is not
+     *         supported by the specified collection
+     * @throws ClassCastException if the class of the elements held by this
+     *         collection prevents them from being added to the specified
+     *         collection
+     * @throws NullPointerException if c is null
+     * @throws IllegalArgumentException if c is this instance
      */
     public int drainTo(Collection<? super E> c, int maxElements) {
         if (c == null) {



Mime
View raw message