From 05b6c75bd3c51ec7092fdc453434f2f80dfb035f Mon Sep 17 00:00:00 2001 From: Stephen Colebourne Date: Mon, 5 Jan 2004 21:37:13 +0000 Subject: [PATCH] Fix javadoc, from Gary Gregory git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131521 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/commons/collections/BeanMap.java | 10 +++++----- .../apache/commons/collections/EnumerationUtils.java | 8 ++++---- .../org/apache/commons/collections/MapIterator.java | 8 ++++---- .../apache/commons/collections/OrderedIterator.java | 8 ++++---- .../commons/collections/map/AbstractHashedMap.java | 6 ++---- .../org/apache/commons/collections/map/LRUMap.java | 7 ++----- 6 files changed, 21 insertions(+), 26 deletions(-) diff --git a/src/java/org/apache/commons/collections/BeanMap.java b/src/java/org/apache/commons/collections/BeanMap.java index 525cdd8f1..5dbe6e0cc 100644 --- a/src/java/org/apache/commons/collections/BeanMap.java +++ b/src/java/org/apache/commons/collections/BeanMap.java @@ -1,10 +1,10 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BeanMap.java,v 1.25 2003/12/05 20:23:57 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BeanMap.java,v 1.26 2004/01/05 21:37:13 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 * - * Copyright (c) 2001-2003 The Apache Software Foundation. All rights + * Copyright (c) 2001-2004 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without @@ -84,7 +84,7 @@ import org.apache.commons.collections.set.UnmodifiableSet; * property is considered non existent in the Map * * @since Commons Collections 1.0 - * @version $Revision: 1.25 $ $Date: 2003/12/05 20:23:57 $ + * @version $Revision: 1.26 $ $Date: 2004/01/05 21:37:13 $ * * @author James Strachan * @author Stephen Colebourne @@ -519,7 +519,7 @@ public class BeanMap extends AbstractMap implements Cloneable { } public Object next() { Object key = iter.next(); - return get( (String) key ); + return get(key); } public void remove() { throw new UnsupportedOperationException( "remove() not supported for BeanMap" ); @@ -780,7 +780,7 @@ public class BeanMap extends AbstractMap implements Cloneable { * to that type * @throws InstantiationException if the constructor found with * reflection raises it - * @throws InvocationTargetExcetpion if the constructor found with + * @throws InvocationTargetException if the constructor found with * reflection raises it * @throws IllegalAccessException never * @throws IllegalArgumentException never diff --git a/src/java/org/apache/commons/collections/EnumerationUtils.java b/src/java/org/apache/commons/collections/EnumerationUtils.java index 0b7749e60..007d63d3b 100644 --- a/src/java/org/apache/commons/collections/EnumerationUtils.java +++ b/src/java/org/apache/commons/collections/EnumerationUtils.java @@ -1,10 +1,10 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/EnumerationUtils.java,v 1.2 2004/01/05 21:23:44 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/EnumerationUtils.java,v 1.3 2004/01/05 21:37:13 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 * - * Copyright (c) 1999-2004 The Apache Software Foundation. All rights + * Copyright (c) 2003-2004 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without @@ -66,7 +66,7 @@ import org.apache.commons.collections.iterators.EnumerationIterator; * Provides utility methods for {@link Enumeration} instances. * * @since Commons Collections 3.0 - * @version $Id: EnumerationUtils.java,v 1.2 2004/01/05 21:23:44 scolebourne Exp $ + * @version $Id: EnumerationUtils.java,v 1.3 2004/01/05 21:37:13 scolebourne Exp $ * * @author Gary Gregory */ @@ -86,7 +86,7 @@ public class EnumerationUtils { * created. The new list is returned.

* * @param enumeration the enumeration to traverse, which should not be null. - * @throws NullPointerException if the enumeration parameter is null. + * @throws NullPointerException if the enumeration parameter is null. */ public static List toList(Enumeration enumeration) { return IteratorUtils.toList(new EnumerationIterator(enumeration)); diff --git a/src/java/org/apache/commons/collections/MapIterator.java b/src/java/org/apache/commons/collections/MapIterator.java index 4910266e5..758c1a963 100644 --- a/src/java/org/apache/commons/collections/MapIterator.java +++ b/src/java/org/apache/commons/collections/MapIterator.java @@ -1,10 +1,10 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MapIterator.java,v 1.4 2003/12/02 23:51:49 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MapIterator.java,v 1.5 2004/01/05 21:37:13 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 * - * Copyright (c) 2001-2003 The Apache Software Foundation. All rights + * Copyright (c) 2003-2004 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without @@ -82,7 +82,7 @@ import java.util.Iterator; * * * @since Commons Collections 3.0 - * @version $Revision: 1.4 $ $Date: 2003/12/02 23:51:49 $ + * @version $Revision: 1.5 $ $Date: 2004/01/05 21:37:13 $ * * @author Stephen Colebourne */ @@ -99,7 +99,7 @@ public interface MapIterator extends Iterator { * Gets the next key from the Map. * * @return the next key in the iteration - * @throws NoSuchElementException if the iteration is finished + * @throws java.util.NoSuchElementException if the iteration is finished */ Object next(); diff --git a/src/java/org/apache/commons/collections/OrderedIterator.java b/src/java/org/apache/commons/collections/OrderedIterator.java index a7584053c..1bb68a23d 100644 --- a/src/java/org/apache/commons/collections/OrderedIterator.java +++ b/src/java/org/apache/commons/collections/OrderedIterator.java @@ -1,10 +1,10 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/OrderedIterator.java,v 1.1 2003/12/01 22:48:59 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/OrderedIterator.java,v 1.2 2004/01/05 21:37:13 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 * - * Copyright (c) 2001-2003 The Apache Software Foundation. All rights + * Copyright (c) 2003-2004 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without @@ -65,7 +65,7 @@ import java.util.Iterator; * This iterator allows both forward and reverse iteration through the collection. * * @since Commons Collections 3.0 - * @version $Revision: 1.1 $ $Date: 2003/12/01 22:48:59 $ + * @version $Revision: 1.2 $ $Date: 2004/01/05 21:37:13 $ * * @author Stephen Colebourne */ @@ -82,7 +82,7 @@ public interface OrderedIterator extends Iterator { * Gets the previous element from the collection. * * @return the previous key in the iteration - * @throws NoSuchElementException if the iteration is finished + * @throws java.util.NoSuchElementException if the iteration is finished */ Object previous(); diff --git a/src/java/org/apache/commons/collections/map/AbstractHashedMap.java b/src/java/org/apache/commons/collections/map/AbstractHashedMap.java index 67a454057..b71da4cb7 100644 --- a/src/java/org/apache/commons/collections/map/AbstractHashedMap.java +++ b/src/java/org/apache/commons/collections/map/AbstractHashedMap.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractHashedMap.java,v 1.6 2004/01/03 05:15:00 psteitz Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractHashedMap.java,v 1.7 2004/01/05 21:32:10 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -88,7 +88,7 @@ import org.apache.commons.collections.MapIterator; * need for unusual subclasses is here. * * @since Commons Collections 3.0 - * @version $Revision: 1.6 $ $Date: 2004/01/03 05:15:00 $ + * @version $Revision: 1.7 $ $Date: 2004/01/05 21:32:10 $ * * @author java util HashMap * @author Stephen Colebourne @@ -480,7 +480,6 @@ public class AbstractHashedMap implements IterableMap { * * @param entry the entry to update * @param newValue the new value to store - * @return value the previous value */ protected void updateEntry(HashEntry entry, Object newValue) { entry.setValue(newValue); @@ -518,7 +517,6 @@ public class AbstractHashedMap implements IterableMap { * @param hashCode the hash code of the key to add * @param key the key to add * @param value the value to add - * @return the value previously mapped to this key, null if none */ protected void addMapping(int hashIndex, int hashCode, Object key, Object value) { modCount++; diff --git a/src/java/org/apache/commons/collections/map/LRUMap.java b/src/java/org/apache/commons/collections/map/LRUMap.java index a699a5fb0..734f5f61d 100644 --- a/src/java/org/apache/commons/collections/map/LRUMap.java +++ b/src/java/org/apache/commons/collections/map/LRUMap.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/LRUMap.java,v 1.5 2004/01/02 01:36:52 psteitz Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/LRUMap.java,v 1.6 2004/01/05 21:32:47 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -83,7 +83,7 @@ import org.apache.commons.collections.BoundedMap; * ResettableIterator and calling reset(). * * @since Commons Collections 3.0 - * @version $Revision: 1.5 $ $Date: 2004/01/02 01:36:52 $ + * @version $Revision: 1.6 $ $Date: 2004/01/05 21:32:47 $ * * @author James Strachan * @author Morgan Delagrange @@ -194,7 +194,6 @@ public class LRUMap extends AbstractLinkedMap * * @param entry the entry to update * @param newValue the new value to store - * @return value the previous value */ protected void updateEntry(HashEntry entry, Object newValue) { moveToMRU((LinkEntry) entry); // handles modCount @@ -210,7 +209,6 @@ public class LRUMap extends AbstractLinkedMap * @param hashCode the hash code of the key to add * @param key the key to add * @param value the value to add - * @return the value previously mapped to this key, null if none */ protected void addMapping(int hashIndex, int hashCode, Object key, Object value) { if (size >= maxSize && removeLRU(header.before)) { @@ -228,7 +226,6 @@ public class LRUMap extends AbstractLinkedMap * @param hashCode the hash code of the key to add * @param key the key to add * @param value the value to add - * @return the value previously mapped to this key, null if none */ protected void reuseMapping(LinkEntry entry, int hashIndex, int hashCode, Object key, Object value) { // find the entry before the entry specified in the hash table