commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections CommonsLinkedList.java NodeCachingLinkedList.java BufferOverflowException.java TransformerUtils.java MultiMap.java ReferenceMap.java BufferUnderflowException.java UnboundedFifoBuffer.java MultiHashMap.java ExtendedProperties.java
Date Thu, 09 Oct 2003 20:58:53 GMT
scolebourne    2003/10/09 13:58:53

  Modified:    collections/src/java/org/apache/commons/collections
                        CommonsLinkedList.java NodeCachingLinkedList.java
                        BufferOverflowException.java TransformerUtils.java
                        MultiMap.java ReferenceMap.java
                        BufferUnderflowException.java
                        UnboundedFifoBuffer.java MultiHashMap.java
                        ExtendedProperties.java
  Log:
  Fix various javadoc link warnings
  bug 23680, from Eric Johnson
  
  Revision  Changes    Path
  1.9       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/CommonsLinkedList.java
  
  Index: CommonsLinkedList.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/CommonsLinkedList.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- CommonsLinkedList.java	5 Oct 2003 06:41:08 -0000	1.8
  +++ CommonsLinkedList.java	9 Oct 2003 20:58:52 -0000	1.9
  @@ -78,7 +78,7 @@
    * @since Commons Collections 3.0
    * @version $Revision$ $Date$
    * 
  - * @author <a href="mailto:rich@rd.gen.nz">Rich Dougherty</a>
  + * @author Rich Dougherty
    * @author Phil Steitz
    */
   class CommonsLinkedList extends LinkedList
  
  
  
  1.9       +2 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/NodeCachingLinkedList.java
  
  Index: NodeCachingLinkedList.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/NodeCachingLinkedList.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- NodeCachingLinkedList.java	5 Oct 2003 06:41:08 -0000	1.8
  +++ NodeCachingLinkedList.java	9 Oct 2003 20:58:52 -0000	1.9
  @@ -229,8 +229,6 @@
        * 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.7       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/BufferOverflowException.java
  
  Index: BufferOverflowException.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/BufferOverflowException.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- BufferOverflowException.java	31 Aug 2003 17:26:44 -0000	1.6
  +++ BufferOverflowException.java	9 Oct 2003 20:58:52 -0000	1.7
  @@ -96,7 +96,7 @@
        * 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       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/TransformerUtils.java
  
  Index: TransformerUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/TransformerUtils.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- TransformerUtils.java	17 Sep 2003 20:28:30 -0000	1.4
  +++ TransformerUtils.java	9 Oct 2003 20:58:52 -0000	1.5
  @@ -189,7 +189,7 @@
        * 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.8       +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/MultiMap.java
  
  Index: MultiMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/MultiMap.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- MultiMap.java	31 Aug 2003 17:26:43 -0000	1.7
  +++ MultiMap.java	9 Oct 2003 20:58:52 -0000	1.8
  @@ -82,7 +82,7 @@
    * @version $Revision$ $Date$
    * 
    * @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 @@
        * 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.16      +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/ReferenceMap.java
  
  Index: ReferenceMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/ReferenceMap.java,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- ReferenceMap.java	3 Oct 2003 23:19:32 -0000	1.15
  +++ ReferenceMap.java	9 Oct 2003 20:58:52 -0000	1.16
  @@ -188,7 +188,7 @@
   
       /**
        *  ReferenceQueue used to eliminate stale mappings.
  -     *  @see #purge
  +     *  See purge.
        */
       private transient ReferenceQueue queue = new ReferenceQueue();
   
  @@ -207,7 +207,7 @@
   
       /**
        *  When size reaches threshold, the map is resized.  
  -     *  @see resize
  +     *  See resize().
        */
       private transient int threshold;
   
  
  
  
  1.8       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/BufferUnderflowException.java
  
  Index: BufferUnderflowException.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/BufferUnderflowException.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- BufferUnderflowException.java	31 Aug 2003 17:26:44 -0000	1.7
  +++ BufferUnderflowException.java	9 Oct 2003 20:58:52 -0000	1.8
  @@ -95,7 +95,7 @@
        * 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.9       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java
  
  Index: UnboundedFifoBuffer.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- UnboundedFifoBuffer.java	7 Sep 2003 08:48:46 -0000	1.8
  +++ UnboundedFifoBuffer.java	9 Oct 2003 20:58:53 -0000	1.9
  @@ -153,7 +153,7 @@
       /**
        * 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
  
  
  
  1.13      +5 -5      jakarta-commons/collections/src/java/org/apache/commons/collections/MultiHashMap.java
  
  Index: MultiHashMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/MultiHashMap.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- MultiHashMap.java	31 Aug 2003 17:26:43 -0000	1.12
  +++ MultiHashMap.java	9 Oct 2003 20:58:53 -0000	1.13
  @@ -92,10 +92,10 @@
    * @version $Revision$ $Date$
    * 
    * @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 @@
        * 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.17      +16 -16    jakarta-commons/collections/src/java/org/apache/commons/collections/ExtendedProperties.java
  
  Index: ExtendedProperties.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/ExtendedProperties.java,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- ExtendedProperties.java	31 Aug 2003 17:26:44 -0000	1.16
  +++ ExtendedProperties.java	9 Oct 2003 20:58:53 -0000	1.17
  @@ -323,8 +323,8 @@
           /**
            * 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 @@
           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 @@
        * <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 @@
               // 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 @@
           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 @@
               
           } 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 @@
        * 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 @@
        * <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";
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message