Javadoc fixes.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1353142 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
44709d8b2a
commit
b0d4ee9244
|
@ -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() {
|
||||
|
|
|
@ -157,8 +157,7 @@ public class ExtendedProperties extends Hashtable<String, Object> {
|
|||
private ExtendedProperties defaults;
|
||||
|
||||
/**
|
||||
* The file connected to this repository (holding comments and
|
||||
* such).
|
||||
* The file connected to this repository (holding comments and such).
|
||||
*
|
||||
* @serial
|
||||
*/
|
||||
|
|
|
@ -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,6 +100,7 @@ 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}
|
||||
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue