Fix various javadoc link warnings
bug 23680, from Eric Johnson git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131271 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne
parent
5db7fd6976
commit
29e063ff3f
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BufferOverflowException.java,v 1.6 2003/08/31 17:26:44 scolebourne Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BufferOverflowException.java,v 1.7 2003/10/09 20:58:52 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -62,7 +62,7 @@ package org.apache.commons.collections;
|
|||
* exceeded.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @version $Revision: 1.6 $ $Date: 2003/08/31 17:26:44 $
|
||||
* @version $Revision: 1.7 $ $Date: 2003/10/09 20:58:52 $
|
||||
*
|
||||
* @author Avalon
|
||||
* @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
|
||||
|
|
@ -96,7 +96,7 @@ public class BufferOverflowException extends RuntimeException {
|
|||
* Construct a new <code>BufferOverflowException</code>.
|
||||
*
|
||||
* @param message the detail message for this exception
|
||||
* @param throwable the root cause of the exception
|
||||
* @param exception the root cause of the exception
|
||||
*/
|
||||
public BufferOverflowException(String message, Throwable exception) {
|
||||
super(message);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BufferUnderflowException.java,v 1.7 2003/08/31 17:26:44 scolebourne Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BufferUnderflowException.java,v 1.8 2003/10/09 20:58:52 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -61,7 +61,7 @@ package org.apache.commons.collections;
|
|||
* The BufferUnderflowException is used when the buffer is already empty.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @version $Revision: 1.7 $ $Date: 2003/08/31 17:26:44 $
|
||||
* @version $Revision: 1.8 $ $Date: 2003/10/09 20:58:52 $
|
||||
*
|
||||
* @author Avalon
|
||||
* @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
|
||||
|
|
@ -95,7 +95,7 @@ public class BufferUnderflowException extends RuntimeException {
|
|||
* Construct a new <code>BufferUnderflowException</code>.
|
||||
*
|
||||
* @param message the detail message for this exception
|
||||
* @param throwable the root cause of the exception
|
||||
* @param exception the root cause of the exception
|
||||
*/
|
||||
public BufferUnderflowException(String message, Throwable exception) {
|
||||
super(message);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/CommonsLinkedList.java,v 1.8 2003/10/05 06:41:08 psteitz Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/CommonsLinkedList.java,v 1.9 2003/10/09 20:58:52 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -76,9 +76,9 @@ import java.util.NoSuchElementException;
|
|||
* subclasses to extend.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.8 $ $Date: 2003/10/05 06:41:08 $
|
||||
* @version $Revision: 1.9 $ $Date: 2003/10/09 20:58:52 $
|
||||
*
|
||||
* @author <a href="mailto:rich@rd.gen.nz">Rich Dougherty</a>
|
||||
* @author Rich Dougherty
|
||||
* @author Phil Steitz
|
||||
*/
|
||||
class CommonsLinkedList extends LinkedList
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ExtendedProperties.java,v 1.16 2003/08/31 17:26:44 scolebourne Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ExtendedProperties.java,v 1.17 2003/10/09 20:58:53 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -161,7 +161,7 @@ import java.util.Vector;
|
|||
* it, go ahead and tune it up!
|
||||
*
|
||||
* @since Commons Collections 1.0
|
||||
* @version $Revision: 1.16 $ $Date: 2003/08/31 17:26:44 $
|
||||
* @version $Revision: 1.17 $ $Date: 2003/10/09 20:58:53 $
|
||||
*
|
||||
* @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>
|
||||
* @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
|
||||
|
|
@ -323,8 +323,8 @@ public class ExtendedProperties extends Hashtable {
|
|||
/**
|
||||
* Read a property.
|
||||
*
|
||||
* @return A String.
|
||||
* @throws IOException.
|
||||
* @return a String property
|
||||
* @throws IOException if there is difficulty reading the source.
|
||||
*/
|
||||
public String readProperty() throws IOException {
|
||||
StringBuffer buffer = new StringBuffer();
|
||||
|
|
@ -767,7 +767,7 @@ public class ExtendedProperties extends Hashtable {
|
|||
Enumeration theKeys = keys();
|
||||
while (theKeys.hasMoreElements()) {
|
||||
String key = (String) theKeys.nextElement();
|
||||
Object value = get((Object) key);
|
||||
Object value = get(key);
|
||||
if (value != null) {
|
||||
if (value instanceof String) {
|
||||
StringBuffer currentOutput = new StringBuffer();
|
||||
|
|
@ -799,12 +799,12 @@ public class ExtendedProperties extends Hashtable {
|
|||
* <p>
|
||||
* Warning: It will overwrite previous entries without warning.
|
||||
*
|
||||
* @param ExtendedProperties
|
||||
* @param props the properties to combine
|
||||
*/
|
||||
public void combine(ExtendedProperties c) {
|
||||
for (Iterator i = c.getKeys(); i.hasNext();) {
|
||||
String key = (String) i.next();
|
||||
setProperty(key, c.get(key));
|
||||
public void combine(ExtendedProperties props) {
|
||||
for (Iterator it = props.getKeys(); it.hasNext();) {
|
||||
String key = (String) it.next();
|
||||
setProperty(key, props.get(key));
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -818,7 +818,7 @@ public class ExtendedProperties extends Hashtable {
|
|||
// we also need to rebuild the keysAsListed or else
|
||||
// things get *very* confusing
|
||||
for (int i = 0; i < keysAsListed.size(); i++) {
|
||||
if (((String) keysAsListed.get(i)).equals(key)) {
|
||||
if (( keysAsListed.get(i)).equals(key)) {
|
||||
keysAsListed.remove(i);
|
||||
break;
|
||||
}
|
||||
|
|
@ -947,7 +947,7 @@ public class ExtendedProperties extends Hashtable {
|
|||
Object value = get(key);
|
||||
|
||||
if (value instanceof String) {
|
||||
return (String) interpolate((String) value);
|
||||
return interpolate((String) value);
|
||||
|
||||
} else if (value == null) {
|
||||
if (defaults != null) {
|
||||
|
|
@ -1080,7 +1080,7 @@ public class ExtendedProperties extends Hashtable {
|
|||
|
||||
} else if (value instanceof String) {
|
||||
Vector v = new Vector(1);
|
||||
v.addElement((String) value);
|
||||
v.addElement(value);
|
||||
put(key, v);
|
||||
return v;
|
||||
|
||||
|
|
@ -1106,7 +1106,7 @@ public class ExtendedProperties extends Hashtable {
|
|||
* object that is not a Boolean.
|
||||
*/
|
||||
public boolean getBoolean(String key) {
|
||||
Boolean b = getBoolean(key, (Boolean) null);
|
||||
Boolean b = getBoolean(key, null);
|
||||
if (b != null) {
|
||||
return b.booleanValue();
|
||||
} else {
|
||||
|
|
@ -1169,12 +1169,12 @@ public class ExtendedProperties extends Hashtable {
|
|||
* <code>false</code> boolean values. Case of value to test for
|
||||
* boolean status is ignored.
|
||||
*
|
||||
* @param String The value to test for boolean state.
|
||||
* @param value the value to test for boolean state
|
||||
* @return <code>true</code> or <code>false</code> if the supplied
|
||||
* text maps to a boolean value, or <code>null</code> otherwise.
|
||||
*/
|
||||
public String testBoolean(String value) {
|
||||
String s = ((String) value).toLowerCase();
|
||||
String s = value.toLowerCase();
|
||||
|
||||
if (s.equals("true") || s.equals("on") || s.equals("yes")) {
|
||||
return "true";
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MultiHashMap.java,v 1.12 2003/08/31 17:26:43 scolebourne Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MultiHashMap.java,v 1.13 2003/10/09 20:58:53 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -89,13 +89,13 @@ import java.util.Set;
|
|||
* <code>coll</code> will be a list containing "A", "B", "C".
|
||||
*
|
||||
* @since Commons Collections 2.0
|
||||
* @version $Revision: 1.12 $ $Date: 2003/08/31 17:26:43 $
|
||||
* @version $Revision: 1.13 $ $Date: 2003/10/09 20:58:53 $
|
||||
*
|
||||
* @author Christopher Berry
|
||||
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
|
||||
* @author James Strachan
|
||||
* @author Steve Downey
|
||||
* @author Stephen Colebourne
|
||||
* @author <a href="mailto:jburet@yahoo.com">Julien Buret</a>
|
||||
* @author Julien Buret
|
||||
* @author Serhiy Yevtushenko
|
||||
*/
|
||||
public class MultiHashMap extends HashMap implements MultiMap {
|
||||
|
|
@ -222,7 +222,7 @@ public class MultiHashMap extends HashMap implements MultiMap {
|
|||
* The item is removed from the collection mapped to the specified key.
|
||||
*
|
||||
* @param key the key to remove from
|
||||
* @param value the value to remove
|
||||
* @param item the value to remove
|
||||
* @return the value removed (which was passed in)
|
||||
*/
|
||||
public Object remove(Object key, Object item) {
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MultiMap.java,v 1.7 2003/08/31 17:26:43 scolebourne Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MultiMap.java,v 1.8 2003/10/09 20:58:52 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -79,10 +79,10 @@ import java.util.Map;
|
|||
* <code>coll</code> will be a list containing "A", "B", "C".
|
||||
*
|
||||
* @since Commons Collections 2.0
|
||||
* @version $Revision: 1.7 $ $Date: 2003/08/31 17:26:43 $
|
||||
* @version $Revision: 1.8 $ $Date: 2003/10/09 20:58:52 $
|
||||
*
|
||||
* @author Christopher Berry
|
||||
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
|
||||
* @author James Strachan
|
||||
* @author Stephen Colebourne
|
||||
*/
|
||||
public interface MultiMap extends Map {
|
||||
|
|
@ -93,7 +93,7 @@ public interface MultiMap extends Map {
|
|||
* The item is removed from the collection mapped to the specified key.
|
||||
*
|
||||
* @param key the key to remove from
|
||||
* @param value the value to remove
|
||||
* @param item the item to remove
|
||||
* @return the value removed (which was passed in)
|
||||
*/
|
||||
public Object remove(Object key, Object item);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/NodeCachingLinkedList.java,v 1.8 2003/10/05 06:41:08 psteitz Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/NodeCachingLinkedList.java,v 1.9 2003/10/09 20:58:52 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -65,7 +65,7 @@ import java.util.Collection;
|
|||
* improvement.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.8 $ $Date: 2003/10/05 06:41:08 $
|
||||
* @version $Revision: 1.9 $ $Date: 2003/10/09 20:58:52 $
|
||||
*
|
||||
* @author Jeff Varszegi
|
||||
* @author <a href="mailto:rich@rd.gen.nz">Rich Dougherty</a>
|
||||
|
|
@ -229,8 +229,6 @@ public class NodeCachingLinkedList extends CommonsLinkedList {
|
|||
* Calls the superclass' implementation then calls
|
||||
* <code>addNodeToCache</code> on the node which has
|
||||
* been removed.
|
||||
*
|
||||
* @see CommonsLinkedList#removeNode(Node)
|
||||
*/
|
||||
protected void removeNode(Node node) {
|
||||
super.removeNode(node);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ReferenceMap.java,v 1.15 2003/10/03 23:19:32 scolebourne Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ReferenceMap.java,v 1.16 2003/10/09 20:58:52 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -118,7 +118,7 @@ import org.apache.commons.collections.pairs.DefaultMapEntry;
|
|||
* @see java.lang.ref.Reference
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @version $Revision: 1.15 $ $Date: 2003/10/03 23:19:32 $
|
||||
* @version $Revision: 1.16 $ $Date: 2003/10/09 20:58:52 $
|
||||
*
|
||||
* @author Paul Jack
|
||||
*/
|
||||
|
|
@ -188,7 +188,7 @@ public class ReferenceMap extends AbstractMap {
|
|||
|
||||
/**
|
||||
* ReferenceQueue used to eliminate stale mappings.
|
||||
* @see #purge
|
||||
* See purge.
|
||||
*/
|
||||
private transient ReferenceQueue queue = new ReferenceQueue();
|
||||
|
||||
|
|
@ -207,7 +207,7 @@ public class ReferenceMap extends AbstractMap {
|
|||
|
||||
/**
|
||||
* When size reaches threshold, the map is resized.
|
||||
* @see resize
|
||||
* See resize().
|
||||
*/
|
||||
private transient int threshold;
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/TransformerUtils.java,v 1.4 2003/09/17 20:28:30 scolebourne Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/TransformerUtils.java,v 1.5 2003/10/09 20:58:52 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -87,7 +87,7 @@ import java.util.Map;
|
|||
* All the supplied transformers are Serializable.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @version $Revision: 1.4 $ $Date: 2003/09/17 20:28:30 $
|
||||
* @version $Revision: 1.5 $ $Date: 2003/10/09 20:58:52 $
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author James Carman
|
||||
|
|
@ -189,7 +189,7 @@ public class TransformerUtils {
|
|||
* Creates a Transformer that calls a Closure each time the transformer is used.
|
||||
* The transformer returns the input object.
|
||||
*
|
||||
* @param command the command to run each time in the transformer
|
||||
* @param closure the closure to run each time in the transformer
|
||||
* @return the transformer.
|
||||
*/
|
||||
public static Transformer asTransformer(Closure closure) {
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java,v 1.8 2003/09/07 08:48:46 scolebourne Exp $
|
||||
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java,v 1.9 2003/10/09 20:58:53 scolebourne Exp $
|
||||
* ====================================================================
|
||||
*
|
||||
* The Apache Software License, Version 1.1
|
||||
|
|
@ -83,7 +83,7 @@ import java.util.NoSuchElementException;
|
|||
* This buffer prevents null objects from being added.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @version $Revision: 1.8 $ $Date: 2003/09/07 08:48:46 $
|
||||
* @version $Revision: 1.9 $ $Date: 2003/10/09 20:58:53 $
|
||||
*
|
||||
* @author Avalon
|
||||
* @author Federico Barbieri
|
||||
|
|
@ -153,7 +153,7 @@ public final class UnboundedFifoBuffer extends AbstractCollection implements Buf
|
|||
/**
|
||||
* Adds the given element to this buffer.
|
||||
*
|
||||
* @param element the element to add
|
||||
* @param o the element to add
|
||||
* @return true, always
|
||||
* @throws NullPointerException if the given element is null
|
||||
* @throws BufferOverflowException if this buffer is full
|
||||
|
|
|
|||
Loading…
Reference in New Issue