commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From t.@apache.org
Subject svn commit: r1353142 - in /commons/proper/collections/trunk/src/main/java/org/apache/commons/collections: BufferUtils.java ExtendedProperties.java FactoryUtils.java
Date Sat, 23 Jun 2012 15:15:06 GMT
Author: tn
Date: Sat Jun 23 15:15:05 2012
New Revision: 1353142

URL: http://svn.apache.org/viewvc?rev=1353142&view=rev
Log:
Javadoc fixes.

Modified:
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/BufferUtils.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/FactoryUtils.java

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/BufferUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/BufferUtils.java?rev=1353142&r1=1353141&r2=1353142&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/BufferUtils.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/BufferUtils.java
Sat Jun 23 15:15:05 2012
@@ -62,6 +62,7 @@ public class BufferUtils {
      * }
      * </pre>
      *
+     * @param <E> the type of the elements in the buffer
      * @param buffer  the buffer to synchronize, must not be null
      * @return a synchronized buffer backed by that buffer
      * @throws IllegalArgumentException  if the Buffer is null
@@ -78,6 +79,7 @@ public class BufferUtils {
      * are added to the buffer, rather than immediately throwing a
      * <code>BufferUnderflowException</code>.
      *
+     * @param <E> the type of the elements in the buffer
      * @param buffer  the buffer to synchronize, must not be null
      * @return a blocking buffer backed by that buffer
      * @throws IllegalArgumentException  if the Buffer is null
@@ -94,6 +96,7 @@ public class BufferUtils {
      * until new elements are added to the buffer, rather than immediately
      * throwing a <code>BufferUnderflowException</code>.
      *
+     * @param <E> the type of the elements in the buffer
      * @param buffer  the buffer to synchronize, must not be null
      * @param timeoutMillis  the timeout value in milliseconds, zero or less for no timeout
      * @return a blocking buffer backed by that buffer
@@ -111,6 +114,7 @@ public class BufferUtils {
      * removed from the buffer to allow the object(s) to be added and still
      * maintain the maximum size.
      *
+     * @param <E> the type of the elements in the buffer
      * @param buffer  the buffer to make bounded,  must not be null
      * @param maximumSize  the maximum size
      * @return a bounded buffer backed by the given buffer
@@ -128,6 +132,7 @@ public class BufferUtils {
      * removed from the buffer to allow the object(s) to be added and still
      * maintain the maximum size or the timeout expires.
      *
+     * @param <E> the type of the elements in the buffer
      * @param buffer the buffer to make bounded, must not be null
      * @param maximumSize the maximum size
      * @param timeoutMillis  the timeout value in milliseconds, zero or less for no timeout
@@ -142,6 +147,7 @@ public class BufferUtils {
     /**
      * Returns an unmodifiable buffer backed by the given buffer.
      *
+     * @param <E> the type of the elements in the buffer
      * @param buffer  the buffer to make unmodifiable, must not be null
      * @return an unmodifiable buffer backed by that buffer
      * @throws IllegalArgumentException  if the Buffer is null
@@ -158,6 +164,7 @@ public class BufferUtils {
      * It is important not to use the original buffer after invoking this method,
      * as it is a backdoor for adding invalid objects.
      *
+     * @param <E> the type of the elements in the buffer
      * @param buffer  the buffer to predicate, must not be null
      * @param predicate  the predicate used to evaluate new elements, must not be null
      * @return a predicated buffer
@@ -177,6 +184,7 @@ public class BufferUtils {
      * Existing entries in the specified buffer will not be transformed.
      * If you want that behaviour, see {@link TransformedBuffer#transformedBuffer}.
      *
+     * @param <E> the type of the elements in the buffer
      * @param buffer  the buffer to predicate, must not be null
      * @param transformer  the transformer for the buffer, must not be null
      * @return a transformed buffer backed by the given buffer
@@ -188,8 +196,9 @@ public class BufferUtils {
 
     /**
      * Get an empty <code>Buffer</code>.
-     * @param <E>
-     * @return Buffer<E>
+     *
+     * @param <E> the type of the elements in the buffer
+     * @return an empty {@link Buffer<E>}
      */
     @SuppressWarnings("unchecked")
     public static <E> Buffer<E> emptyBuffer() {

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java?rev=1353142&r1=1353141&r2=1353142&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java
Sat Jun 23 15:15:05 2012
@@ -157,8 +157,7 @@ public class ExtendedProperties extends 
     private ExtendedProperties defaults;
 
     /**
-     * The file connected to this repository (holding comments and
-     * such).
+     * The file connected to this repository (holding comments and such).
      *
      * @serial
      */

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/FactoryUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/FactoryUtils.java?rev=1353142&r1=1353141&r2=1353142&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/FactoryUtils.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/FactoryUtils.java
Sat Jun 23 15:15:05 2012
@@ -53,6 +53,7 @@ public class FactoryUtils {
      *
      * @see org.apache.commons.collections.functors.ExceptionFactory
      * 
+     * @param <T> the type that the factory creates
      * @return the factory
      */
     public static <T> Factory<T> exceptionFactory() {
@@ -79,6 +80,7 @@ public class FactoryUtils {
      *
      * @see org.apache.commons.collections.functors.ConstantFactory
      * 
+     * @param <T> the type that the factory creates
      * @param constantToReturn  the constant object to return each time in the factory
      * @return the <code>constant</code> factory.
      */
@@ -98,12 +100,13 @@ public class FactoryUtils {
      *
      * @see org.apache.commons.collections.functors.PrototypeFactory
      * 
+     * @param <T> the type that the factory creates
      * @param prototype  the object to clone each time in the factory
      * @return the <code>prototype</code> factory, or a {@link ConstantFactory#NULL_INSTANCE}
if
      * the {@code prototype} is {@code null}
      * @throws IllegalArgumentException if the prototype cannot be cloned
      */
-    public static <T> Factory<T> prototypeFactory(T  prototype) {
+    public static <T> Factory<T> prototypeFactory(T prototype) {
         return PrototypeFactory.<T>prototypeFactory(prototype);
     }
 
@@ -113,6 +116,7 @@ public class FactoryUtils {
      *
      * @see org.apache.commons.collections.functors.InstantiateFactory
      * 
+     * @param <T> the type that the factory creates
      * @param classToInstantiate  the Class to instantiate each time in the factory
      * @return the <code>reflection</code> factory
      * @throws IllegalArgumentException if the classToInstantiate is null
@@ -127,6 +131,7 @@ public class FactoryUtils {
      *
      * @see org.apache.commons.collections.functors.InstantiateFactory
      * 
+     * @param <T> the type that the factory creates
      * @param classToInstantiate  the Class to instantiate each time in the factory
      * @param paramTypes  parameter types for the constructor, can be null
      * @param args  the arguments to pass to the constructor, can be null



Mime
View raw message