commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ki...@apache.org
Subject [1/3] commons-collections git commit: COLLECTIONS-653 fix Javadoc syntax for Java 8
Date Tue, 12 Sep 2017 10:38:22 GMT
Repository: commons-collections
Updated Branches:
  refs/heads/master 3633bbd32 -> 8dceb1c85


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java b/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java
index b7343d3..8ba588a 100644
--- a/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java
@@ -504,8 +504,8 @@ public class PassiveExpiringMap<K, V>
      * Read the map in using a custom routine.
      *
      * @param in the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      */
     @SuppressWarnings("unchecked")
     // (1) should only fail if input stream is incorrect
@@ -519,7 +519,7 @@ public class PassiveExpiringMap<K, V>
      * Write the map out using a custom routine.
      *
      * @param out the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out)
         throws IOException {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java b/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java
index 948cd73..b8fd06e 100644
--- a/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java
@@ -108,7 +108,7 @@ public class PredicatedMap<K, V>
      * Write the map out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      * @since 3.1
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
@@ -120,8 +120,8 @@ public class PredicatedMap<K, V>
      * Read the map in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      * @since 3.1
      */
     @SuppressWarnings("unchecked") // (1) should only fail if input stream is incorrect

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java b/src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java
index 976a16d..8eafcd2 100644
--- a/src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java
@@ -27,41 +27,48 @@ import java.lang.ref.Reference;
  * removed by the garbage collector and matches keys and values based
  * on <code>==</code> not <code>equals()</code>.
  * <p>
- * <p>
  * When you construct a <code>ReferenceIdentityMap</code>, you can specify what
kind
  * of references are used to store the map's keys and values.
  * If non-hard references are used, then the garbage collector can remove
  * mappings if a key or value becomes unreachable, or if the JVM's memory is
  * running low. For information on how the different reference types behave,
  * see {@link Reference}.
+ * </p>
  * <p>
  * Different types of references can be specified for keys and values.
  * The default constructor uses hard keys and soft values, providing a
  * memory-sensitive cache.
+ * </p>
  * <p>
  * This map is similar to
  * {@link org.apache.commons.collections4.map.ReferenceMap ReferenceMap}.
  * It differs in that keys and values in this class are compared using <code>==</code>.
+ * </p>
  * <p>
  * This map will violate the detail of various Map and map view contracts.
  * As a general rule, don't compare this map to other maps.
+ * </p>
  * <p>
  * This {@link java.util.Map Map} implementation does <i>not</i> allow null elements.
  * Attempting to add a null key or value to the map will raise a <code>NullPointerException</code>.
+ * </p>
  * <p>
  * This implementation is not synchronized.
  * You can use {@link java.util.Collections#synchronizedMap} to
  * provide synchronized access to a <code>ReferenceIdentityMap</code>.
  * Remember that synchronization will not stop the garbage collector removing entries.
+ * </p>
  * <p>
  * All the available iterators can be reset back to the start by casting to
  * <code>ResettableIterator</code> and calling <code>reset()</code>.
+ * </p>
  * <p>
  * <strong>Note that ReferenceIdentityMap is not synchronized and is not thread-safe.</strong>
  * If you wish to use this map from multiple threads concurrently, you must use
  * appropriate synchronization. The simplest approach is to wrap this map
  * using {@link java.util.Collections#synchronizedMap}. This class may throw
  * exceptions when accessed by concurrent threads without synchronization.
+ * </p>
  *
  * @see java.lang.ref.Reference
  *
@@ -223,6 +230,9 @@ public class ReferenceIdentityMap<K, V> extends AbstractReferenceMap<K,
V> imple
     //-----------------------------------------------------------------------
     /**
      * Write the map out using a custom routine.
+     *
+     * @param out the output stream
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -231,6 +241,10 @@ public class ReferenceIdentityMap<K, V> extends AbstractReferenceMap<K,
V> imple
 
     /**
      * Read the map in using a custom routine.
+     *
+     * @param in the input stream
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      */
     private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
{
         in.defaultReadObject();

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java b/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java
index af5e0ce..66f919e 100644
--- a/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java
@@ -167,6 +167,9 @@ public class ReferenceMap<K, V> extends AbstractReferenceMap<K,
V> implements Se
     //-----------------------------------------------------------------------
     /**
      * Write the map out using a custom routine.
+     *
+     * @param out  the output stream
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -175,6 +178,10 @@ public class ReferenceMap<K, V> extends AbstractReferenceMap<K,
V> implements Se
 
     /**
      * Read the map in using a custom routine.
+     *
+     * @param in the input stream
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      */
     private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
{
         in.defaultReadObject();

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/TransformedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/TransformedMap.java b/src/main/java/org/apache/commons/collections4/map/TransformedMap.java
index 4a88259..c8715a3 100644
--- a/src/main/java/org/apache/commons/collections4/map/TransformedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/TransformedMap.java
@@ -132,7 +132,7 @@ public class TransformedMap<K, V>
      * Write the map out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      * @since 3.1
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
@@ -144,8 +144,8 @@ public class TransformedMap<K, V>
      * Read the map in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      * @since 3.1
      */
     @SuppressWarnings("unchecked") // (1) should only fail if input stream is incorrect

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java b/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java
index 6237b78..1348aa6 100644
--- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java
@@ -85,7 +85,7 @@ public final class UnmodifiableMap<K, V>
      * Write the map out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      * @since 3.1
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
@@ -97,8 +97,8 @@ public final class UnmodifiableMap<K, V>
      * Read the map in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      * @since 3.1
      */
     @SuppressWarnings("unchecked")

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java
b/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java
index c180a23..4d5d23b 100644
--- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java
@@ -83,7 +83,7 @@ public final class UnmodifiableOrderedMap<K, V> extends AbstractOrderedMapDecora
      * Write the map out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      * @since 3.1
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
@@ -95,8 +95,8 @@ public final class UnmodifiableOrderedMap<K, V> extends AbstractOrderedMapDecora
      * Read the map in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      * @since 3.1
      */
     @SuppressWarnings("unchecked") // (1) should only fail if input stream is incorrect

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java
b/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java
index 78bfe87..cafa293 100644
--- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java
@@ -83,7 +83,7 @@ public final class UnmodifiableSortedMap<K, V>
      * Write the map out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      * @since 3.1
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
@@ -95,8 +95,8 @@ public final class UnmodifiableSortedMap<K, V>
      * Read the map in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      * @since 3.1
      */
     @SuppressWarnings("unchecked")

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java b/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java
index 5648df9..73ccf07 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java
@@ -59,6 +59,9 @@ public class HashMultiSet<E> extends AbstractMapMultiSet<E>
implements Serializa
     //-----------------------------------------------------------------------
     /**
      * Write the multiset out using a custom routine.
+     *
+     * @param out  the output stream
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -67,6 +70,10 @@ public class HashMultiSet<E> extends AbstractMapMultiSet<E>
implements Serializa
 
     /**
      * Read the multiset in using a custom routine.
+     *
+     * @param in the input stream
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      */
     private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
{
         in.defaultReadObject();

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
index 5398521..bd297b0 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
@@ -78,7 +78,7 @@ public final class UnmodifiableMultiSet<E>
      * Write the collection out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -89,8 +89,8 @@ public final class UnmodifiableMultiSet<E>
      * Read the collection in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      * @throws ClassCastException if deserialised object has wrong type
      */
     @SuppressWarnings("unchecked") // will throw CCE, see Javadoc

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/multiset/package-info.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/package-info.java b/src/main/java/org/apache/commons/collections4/multiset/package-info.java
index 573f141..40378a1 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/package-info.java
@@ -16,14 +16,12 @@
  */
 /**
  * This package contains implementations of the
- * {@link org.apache.commons.collections4.MultiSet MultiSet} and
- * {@link org.apache.commons.collections4.SortedMultiSet SortedMultiSet} interfaces.
+ * {@link org.apache.commons.collections4.MultiSet MultiSet} interface.
  * A multiset stores an object and a count of the number of occurrences of the object.
  * <p>
  * The following implementations are provided in the package:
  * <ul>
  *   <li>HashMultiSet - implementation that uses a HashMap to store the data
- *   <li>TreeMultiSet - implementation that uses a TreeMap to store the data
  * </ul>
  * <p>
  * The following decorators are provided in the package:

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/properties/SortedProperties.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/properties/SortedProperties.java
b/src/main/java/org/apache/commons/collections4/properties/SortedProperties.java
index e5c9f19..833263f 100644
--- a/src/main/java/org/apache/commons/collections4/properties/SortedProperties.java
+++ b/src/main/java/org/apache/commons/collections4/properties/SortedProperties.java
@@ -31,7 +31,7 @@ import org.apache.commons.collections4.iterators.IteratorEnumeration;
  * <p>
  * Overrides {@link Properties#keys()} to sort keys. Allows other methods on the superclass
to work with sorted keys.
  * </p>
- * 
+ *
  * @since 4.2
  */
 public class SortedProperties extends Properties {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java b/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java
index ff21627..6eda1ad 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java
@@ -97,7 +97,7 @@ package org.apache.commons.collections4.sequence;
  *   }
  *
  *   private void display(String commandName, Object object) {
- *     System.out.println(commandName + " " + object + " ->" + this);
+ *     System.out.println(commandName + " " + object + " -&gt;" + this);
  *   }
  *
  *   public String toString() {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
b/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
index e8e74e3..ca4c69d 100644
--- a/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
@@ -49,7 +49,7 @@ public abstract class AbstractSerializableSetDecorator<E>
      * Write the set out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -60,8 +60,8 @@ public abstract class AbstractSerializableSetDecorator<E>
      * Read the set in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      */
     @SuppressWarnings("unchecked")
     private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
b/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
index 3cf0ca8..6135572 100644
--- a/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
@@ -159,7 +159,7 @@ public final class UnmodifiableNavigableSet<E>
      * Write the collection out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -170,8 +170,8 @@ public final class UnmodifiableNavigableSet<E>
      * Read the collection in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      */
     @SuppressWarnings("unchecked") // (1) should only fail if input stream is incorrect
     private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
b/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
index 81d669c..9163a81 100644
--- a/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
@@ -130,7 +130,7 @@ public final class UnmodifiableSortedSet<E>
      * Write the collection out using a custom routine.
      *
      * @param out  the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -141,8 +141,8 @@ public final class UnmodifiableSortedSet<E>
      * Read the collection in using a custom routine.
      *
      * @param in  the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      */
     @SuppressWarnings("unchecked") // (1) should only fail if input stream is incorrect
     private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
index 8aa11dd..fed3e09 100644
--- a/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
@@ -25,8 +25,8 @@ import org.apache.commons.collections4.MapIterator;
 import org.apache.commons.collections4.map.EntrySetToMapIteratorAdapter;
 
 /**
- * {@link IterableGet} that uses a {@link Map}<K, V> for the
- * {@link org.apache.commons.collections4.Get Get}<K, V> implementation.
+ * {@link IterableGet} that uses a {@link Map}&lt;K, V&gt; for the
+ * {@link org.apache.commons.collections4.Get Get}&lt;K, V&gt; implementation.
  *
  * @since 4.0
  * @version $Id$
@@ -111,7 +111,7 @@ public class AbstractIterableGetMapDecorator<K, V> implements IterableGet<K,
V>
 
     /**
      * Get a MapIterator over this Get.
-     * @return MapIterator<K, V>
+     * @return MapIterator&lt;K, V&gt;
      */
     @Override
     public MapIterator<K, V> mapIterator() {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
b/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
index 38f779a..4ace0bc 100644
--- a/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
+++ b/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
@@ -121,7 +121,7 @@ public class TransformedSplitMap<J, K, U, V> extends AbstractIterableGetMapDecor
      * Write the map out using a custom routine.
      *
      * @param out the output stream
-     * @throws IOException
+     * @throws IOException if an error occurs while writing to the stream
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -132,8 +132,8 @@ public class TransformedSplitMap<J, K, U, V> extends AbstractIterableGetMapDecor
      * Read the map in using a custom routine.
      *
      * @param in the input stream
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if an error occurs while reading from the stream
+     * @throws ClassNotFoundException if an object read from the stream can not be loaded
      * @since 3.1
      */
     @SuppressWarnings("unchecked") // (1) should only fail if input stream is incorrect

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
index 3dd8d99..44259c8 100644
--- a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
+++ b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
@@ -45,7 +45,7 @@ abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
V> {
 
     private static final long serialVersionUID = 5155253417231339498L;
 
-    /** The root node of the {@link Trie}. */
+    /** The root node of the {@link org.apache.commons.collections4.Trie}. */
     private transient TrieEntry<K, V> root = new TrieEntry<>(null, null, -1);
 
     /**
@@ -57,11 +57,11 @@ abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
V> {
     private transient volatile Collection<V> values;
     private transient volatile Set<Map.Entry<K,V>> entrySet;
 
-    /** The current size of the {@link Trie}. */
+    /** The current size of the {@link org.apache.commons.collections4.Trie}. */
     private transient int size = 0;
 
     /**
-     * The number of times this {@link Trie} has been modified.
+     * The number of times this {@link org.apache.commons.collections4.Trie} has been modified.
      * It's used to detect concurrent modifications and fail-fast the {@link Iterator}s.
      */
     protected transient int modCount = 0;
@@ -71,8 +71,8 @@ abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
V> {
     }
 
     /**
-     * Constructs a new {@link org.apache.commons.collections4.Trie Trie} using the given
-     * {@link KeyAnalyzer} and initializes the {@link org.apache.commons.collections4.Trie
Trie}
+     * Constructs a new {@link org.apache.commons.collections4.Trie org.apache.commons.collections4.Trie
Trie}
+     * using the given {@link KeyAnalyzer} and initializes the {@link org.apache.commons.collections4.Trie
Trie}
      * with the values from the provided {@link Map}.
      */
     protected AbstractPatriciaTrie(final KeyAnalyzer<? super K> keyAnalyzer,
@@ -271,7 +271,7 @@ abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
V> {
      * <li>L = 1001100
      * </ol>
      *
-     * If the {@link Trie} contained 'H' and 'L', a lookup of 'D' would
+     * If the {@link org.apache.commons.collections4.Trie} contained 'H' and 'L', a lookup
of 'D' would
      * return 'L', because the XOR distance between D &amp; L is smaller
      * than the XOR distance between D &amp; H.
      *
@@ -300,7 +300,7 @@ abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
V> {
      * <li>L = 1001100
      * </ol>
      *
-     * If the {@link Trie} contained 'H' and 'L', a lookup of 'D' would
+     * If the {@link org.apache.commons.collections4.Trie} contained 'H' and 'L', a lookup
of 'D' would
      * return 'L', because the XOR distance between D &amp; L is smaller
      * than the XOR distance between D &amp; H.
      *
@@ -327,7 +327,7 @@ abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
V> {
      * <li>L = 1001100
      * </ol>
      *
-     * If the {@link Trie} contained 'H' and 'L', a lookup of 'D' would
+     * If the {@link org.apache.commons.collections4.Trie} contained 'H' and 'L', a lookup
of 'D' would
      * return 'L', because the XOR distance between D &amp; L is smaller
      * than the XOR distance between D &amp; H.
      *
@@ -1268,7 +1268,7 @@ abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
V> {
     }
 
     /**
-     *  A {@link Trie} is a set of {@link TrieEntry} nodes.
+     *  A {@link org.apache.commons.collections4.Trie} is a set of {@link TrieEntry} nodes.
      */
     protected static class TrieEntry<K,V> extends BasicEntry<K, V> {
 

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java b/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java
index 88b8b7a..ac3b763 100644
--- a/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java
+++ b/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java
@@ -24,10 +24,12 @@ import org.apache.commons.collections4.trie.analyzer.StringKeyAnalyzer;
  * Implementation of a PATRICIA Trie (Practical Algorithm to Retrieve Information
  * Coded in Alphanumeric).
  * <p>
- * A PATRICIA {@link Trie} is a compressed {@link Trie}. Instead of storing
- * all data at the edges of the {@link Trie} (and having empty internal nodes),
- * PATRICIA stores data in every node. This allows for very efficient traversal,
- * insert, delete, predecessor, successor, prefix, range, and {@link #select(Object)}
+ * A PATRICIA {@link org.apache.commons.collections4.Trie} is a compressed
+ * {@link org.apache.commons.collections4.Trie}. Instead of storing
+ * all data at the edges of the {@link org.apache.commons.collections4.Trie}
+ * (and having empty internal nodes), PATRICIA stores data in every node.
+ * This allows for very efficient traversal, insert, delete, predecessor,
+ * successor, prefix, range, and {@link #select(Object)}
  * operations. All operations are performed at worst in O(K) time, where K
  * is the number of bits in the largest item in the tree. In practice,
  * operations actually take O(A(K)) time, where A(K) is the average number of
@@ -38,15 +40,16 @@ import org.apache.commons.collections4.trie.analyzer.StringKeyAnalyzer;
  * K of them, described above) will perform a single bit comparison against
  * the given key, instead of comparing the entire key to another key.
  * <p>
- * The {@link Trie} can return operations in lexicographical order using the
- * 'prefixMap', 'submap', or 'iterator' methods. The {@link Trie} can also
+ * The {@link org.apache.commons.collections4.Trie} can return operations in
+ * lexicographical order using the 'prefixMap', 'submap', or 'iterator' methods.
+ * The {@link org.apache.commons.collections4.Trie} can also
  * scan for items that are 'bitwise' (using an XOR metric) by the 'select' method.
  * Bitwise closeness is determined by the {@link KeyAnalyzer} returning true or
  * false for a bit being set or not in a given key.
  * <p>
- * This PATRICIA {@link Trie} supports both variable length & fixed length
- * keys. Some methods, such as {@link #prefixMap(Object)} are suited only
- * to variable length keys.
+ * This PATRICIA {@link org.apache.commons.collections4.Trie} supports both variable
+ * length &amp; fixed length keys. Some methods, such as {@link #prefixMap(Object)}
+ * are suited only to variable length keys.
  *
  * @see <a href="http://en.wikipedia.org/wiki/Radix_tree">Radix Tree</a>
  * @see <a href="http://www.csse.monash.edu.au/~lloyd/tildeAlgDS/Tree/PATRICIA">PATRICIA</a>


Mime
View raw message