COLLECTIONS-653 fix Javadoc syntax for Java 8
Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-collections/commit/f98ef6d3 Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/f98ef6d3 Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/f98ef6d3 Branch: refs/heads/master Commit: f98ef6d3ba19643262f5538bc5fc93249a75cd50 Parents: 3633bbd Author: Bruno P. Kinoshita <brunodepau...@yahoo.com.br> Authored: Tue Sep 12 22:35:18 2017 +1200 Committer: Bruno P. Kinoshita <brunodepau...@yahoo.com.br> Committed: Tue Sep 12 22:35:18 2017 +1200 ---------------------------------------------------------------------- .../commons/collections4/CollectionUtils.java | 6 ++--- .../commons/collections4/FactoryUtils.java | 9 ++++--- .../commons/collections4/FluentIterable.java | 8 +++--- .../org/apache/commons/collections4/Get.java | 17 +++++++++++++ .../commons/collections4/IterableGet.java | 4 +-- .../commons/collections4/IterableMap.java | 4 +-- .../apache/commons/collections4/MapUtils.java | 4 +-- .../org/apache/commons/collections4/Put.java | 8 ++++++ .../apache/commons/collections4/SetUtils.java | 4 +-- .../commons/collections4/SortedBidiMap.java | 2 +- .../commons/collections4/TransformerUtils.java | 18 ++++++++------ .../commons/collections4/bag/CollectionBag.java | 6 ++--- .../collections4/bag/CollectionSortedBag.java | 6 ++--- .../commons/collections4/bag/HashBag.java | 7 ++++++ .../commons/collections4/bag/TreeBag.java | 7 ++++++ .../collections4/bag/UnmodifiableBag.java | 6 ++--- .../collections4/bag/UnmodifiableSortedBag.java | 6 ++--- .../collections4/bidimap/TreeBidiMap.java | 7 ++++++ .../collection/CompositeCollection.java | 2 +- .../comparators/BooleanComparator.java | 9 ++++--- .../functors/CatchAndRethrowClosure.java | 2 +- .../functors/ComparatorPredicate.java | 26 ++++++++++---------- .../functors/ConstantTransformer.java | 2 +- .../functors/InstantiateTransformer.java | 2 +- .../collections4/functors/PrototypeFactory.java | 10 +++++--- .../iterators/ArrayListIterator.java | 6 ++--- .../collections4/iterators/EmptyIterator.java | 4 +-- .../iterators/EmptyListIterator.java | 4 +-- .../iterators/EmptyMapIterator.java | 2 +- .../iterators/EmptyOrderedIterator.java | 2 +- .../iterators/EmptyOrderedMapIterator.java | 2 +- .../iterators/FilterListIterator.java | 11 +++++++-- .../iterators/IteratorIterable.java | 21 +++++++++------- .../iterators/ObjectArrayListIterator.java | 6 ++--- .../iterators/SingletonIterator.java | 2 +- .../iterators/SingletonListIterator.java | 2 +- .../list/AbstractSerializableListDecorator.java | 6 ++--- .../collections4/list/CursorableLinkedList.java | 7 ++++++ .../list/NodeCachingLinkedList.java | 7 ++++++ .../map/AbstractInputCheckedMapDecorator.java | 6 +++++ .../collections4/map/AbstractLinkedMap.java | 2 +- .../collections4/map/CaseInsensitiveMap.java | 11 ++++++++- .../commons/collections4/map/DefaultedMap.java | 6 ++--- .../map/EntrySetToMapIteratorAdapter.java | 2 +- .../commons/collections4/map/FixedSizeMap.java | 6 ++--- .../collections4/map/FixedSizeSortedMap.java | 7 ++++++ .../commons/collections4/map/Flat3Map.java | 7 ++++++ .../commons/collections4/map/HashedMap.java | 7 ++++++ .../apache/commons/collections4/map/LRUMap.java | 11 +++++++-- .../commons/collections4/map/LazyMap.java | 6 ++--- .../commons/collections4/map/LinkedMap.java | 7 ++++++ .../collections4/map/ListOrderedMap.java | 6 ++--- .../commons/collections4/map/MultiKeyMap.java | 6 ++--- .../commons/collections4/map/MultiValueMap.java | 6 ++--- .../collections4/map/PassiveExpiringMap.java | 6 ++--- .../commons/collections4/map/PredicatedMap.java | 6 ++--- .../collections4/map/ReferenceIdentityMap.java | 16 +++++++++++- .../commons/collections4/map/ReferenceMap.java | 7 ++++++ .../collections4/map/TransformedMap.java | 6 ++--- .../collections4/map/UnmodifiableMap.java | 6 ++--- .../map/UnmodifiableOrderedMap.java | 6 ++--- .../collections4/map/UnmodifiableSortedMap.java | 6 ++--- .../collections4/multiset/HashMultiSet.java | 7 ++++++ .../multiset/UnmodifiableMultiSet.java | 6 ++--- .../collections4/multiset/package-info.java | 4 +-- .../properties/SortedProperties.java | 2 +- .../collections4/sequence/CommandVisitor.java | 2 +- .../set/AbstractSerializableSetDecorator.java | 6 ++--- .../set/UnmodifiableNavigableSet.java | 6 ++--- .../collections4/set/UnmodifiableSortedSet.java | 6 ++--- .../AbstractIterableGetMapDecorator.java | 6 ++--- .../splitmap/TransformedSplitMap.java | 6 ++--- .../collections4/trie/AbstractPatriciaTrie.java | 18 +++++++------- .../commons/collections4/trie/PatriciaTrie.java | 21 +++++++++------- 74 files changed, 333 insertions(+), 176 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/CollectionUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/CollectionUtils.java b/src/main/java/org/apache/commons/collections4/CollectionUtils.java index fb99785..e362db9 100644 --- a/src/main/java/org/apache/commons/collections4/CollectionUtils.java +++ b/src/main/java/org/apache/commons/collections4/CollectionUtils.java @@ -432,7 +432,7 @@ public class CollectionUtils { * Only those elements present in the collection will appear as * keys in the map. * - * @param <O> the type of object in the returned {@link Map}. This is a super type of <I>. + * @param <O> the type of object in the returned {@link Map}. This is a super type of <I>. * @param coll the collection to get the cardinality map for, must not be null * @return the populated cardinality map */ @@ -483,7 +483,7 @@ public class CollectionUtils { * <ul> * <li><code>a.size()</code> and <code>b.size()</code> represent the * total cardinality of <i>a</i> and <i>b</i>, resp. </li> - * <li><code>a.size() < Integer.MAXVALUE</code></li> + * <li><code>a.size() < Integer.MAXVALUE</code></li> * </ul> * * @param a the first (sub?) collection, must not be null @@ -833,7 +833,7 @@ public class CollectionUtils { * Answers true if a predicate is true for every element of a * collection. * <p> - * A <code>null</code> predicate returns false.<br/> + * A <code>null</code> predicate returns false.<br> * A <code>null</code> or empty collection returns true. * * @param <C> the type of object the {@link Iterable} contains http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/FactoryUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/FactoryUtils.java b/src/main/java/org/apache/commons/collections4/FactoryUtils.java index a32d831..e65c0ba 100644 --- a/src/main/java/org/apache/commons/collections4/FactoryUtils.java +++ b/src/main/java/org/apache/commons/collections4/FactoryUtils.java @@ -94,11 +94,12 @@ public class FactoryUtils { * Creates a Factory that will return a clone of the same prototype object * each time the factory is used. The prototype will be cloned using one of these * techniques (in order): + * * <ul> - * <li>public clone method - * <li>public copy constructor - * <li>serialization clone - * <ul> + * <li>public clone method</li> + * <li>public copy constructor</li> + * <li>serialization clone</li> + * </ul> * * @see org.apache.commons.collections4.functors.PrototypeFactory * http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/FluentIterable.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/FluentIterable.java b/src/main/java/org/apache/commons/collections4/FluentIterable.java index b6de3c0..d8563bf 100644 --- a/src/main/java/org/apache/commons/collections4/FluentIterable.java +++ b/src/main/java/org/apache/commons/collections4/FluentIterable.java @@ -47,7 +47,7 @@ import org.apache.commons.collections4.iterators.SingletonIterator; * List<String> result = * FluentIterable * .of(1, 2, 3, 4, 5, 6, 7, 8, 9, 10) - * .filter(new Predicate<Integer>() { + * .filter(new Predicate<Integer>() { * public boolean evaluate(Integer number) { * return number % 2 == 0; * } @@ -192,7 +192,7 @@ public class FluentIterable<E> implements Iterable<E> { * @param other the other iterable to collate, may not be null * @return a new iterable, collating this iterable with the other in natural order * @throws NullPointerException if other is null - * @see {@link org.apache.commons.collections4.iterators.CollatingIterator CollatingIterator} + * @see org.apache.commons.collections4.iterators.CollatingIterator */ public FluentIterable<E> collate(final Iterable<? extends E> other) { return of(IterableUtils.collatedIterable(iterable, other)); @@ -217,7 +217,7 @@ public class FluentIterable<E> implements Iterable<E> { * @param other the other iterable to collate, may not be null * @return a new iterable, collating this iterable with the other in natural order * @throws NullPointerException if other is null - * @see {@link org.apache.commons.collections4.iterators.CollatingIterator CollatingIterator} + * @see org.apache.commons.collections4.iterators.CollatingIterator */ public FluentIterable<E> collate(final Iterable<? extends E> other, final Comparator<? super E> comparator) { @@ -231,7 +231,7 @@ public class FluentIterable<E> implements Iterable<E> { * <p> * Calling this method is equivalent to: * <pre> - * FluentIterable<E> someIterable = ...; + * FluentIterable<E> someIterable = ...; * FluentIterable.of(someIterable.toList()); * </pre> * http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/Get.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/Get.java b/src/main/java/org/apache/commons/collections4/Get.java index 5508ba7..7a1c8fa 100644 --- a/src/main/java/org/apache/commons/collections4/Get.java +++ b/src/main/java/org/apache/commons/collections4/Get.java @@ -30,46 +30,63 @@ import java.util.Set; public interface Get<K, V> { /** + * @param key key whose presence in this map is to be tested + * @return <tt>true</tt> if this map contains a mapping for the specified + * key * @see java.util.Map#containsKey(Object) */ boolean containsKey(Object key); /** + * @param value value whose presence in this map is to be tested + * @return <tt>true</tt> if this map maps one or more keys to the + * specified value * @see java.util.Map#containsValue(Object) */ boolean containsValue(Object value); /** + * @return a set view of the mappings contained in this map * @see java.util.Map#entrySet() */ Set<java.util.Map.Entry<K, V>> entrySet(); /** + * @param key the key whose associated value is to be returned + * @return the value to which the specified key is mapped, or + * {@code null} if this map contains no mapping for the key * @see java.util.Map#get(Object) */ V get(Object key); /** + * @param key key whose mapping is to be removed from the map + * @return the previous value associated with <tt>key</tt>, or + * <tt>null</tt> if there was no mapping for <tt>key</tt>. * @see java.util.Map#remove(Object) */ V remove(Object key); /** + * @return <tt>true</tt> if this map contains no key-value mappings * @see java.util.Map#isEmpty() */ boolean isEmpty(); /** + * @return a set view of the keys contained in this map * @see java.util.Map#keySet() */ Set<K> keySet(); /** + * @return the number of key-value mappings in this map * @see java.util.Map#size() */ int size(); /** + * @return a collection view of the values contained in this map * @see java.util.Map#values() */ Collection<V> values(); http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/IterableGet.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/IterableGet.java b/src/main/java/org/apache/commons/collections4/IterableGet.java index 1edde5a..41fece0 100644 --- a/src/main/java/org/apache/commons/collections4/IterableGet.java +++ b/src/main/java/org/apache/commons/collections4/IterableGet.java @@ -31,8 +31,8 @@ public interface IterableGet<K, V> extends Get<K, V> { * A map iterator is an efficient way of iterating over maps. * There is no need to access the entry set or use Map Entry objects. * <pre> - * IterableMap<String,Integer> map = new HashedMap<String,Integer>(); - * MapIterator<String,Integer> it = map.mapIterator(); + * IterableMap<String,Integer> map = new HashedMap<String,Integer>(); + * MapIterator<String,Integer> it = map.mapIterator(); * while (it.hasNext()) { * String key = it.next(); * Integer value = it.getValue(); http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/IterableMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/IterableMap.java b/src/main/java/org/apache/commons/collections4/IterableMap.java index 9169561..79f7238 100644 --- a/src/main/java/org/apache/commons/collections4/IterableMap.java +++ b/src/main/java/org/apache/commons/collections4/IterableMap.java @@ -24,8 +24,8 @@ import java.util.Map; * A map iterator is an efficient way of iterating over maps. * There is no need to access the entry set or use Map Entry objects. * <pre> - * IterableMap<String,Integer> map = new HashedMap<String,Integer>(); - * MapIterator<String,Integer> it = map.mapIterator(); + * IterableMap<String,Integer> map = new HashedMap<String,Integer>(); + * MapIterator<String,Integer> it = map.mapIterator(); * while (it.hasNext()) { * String key = it.next(); * Integer value = it.getValue(); http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/MapUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/MapUtils.java b/src/main/java/org/apache/commons/collections4/MapUtils.java index c11437e..0ae9dba 100644 --- a/src/main/java/org/apache/commons/collections4/MapUtils.java +++ b/src/main/java/org/apache/commons/collections4/MapUtils.java @@ -1765,7 +1765,7 @@ public class MapUtils { * @param <K> the key type * @param <V> the value type * @param map to wrap if necessary. - * @return IterableMap<K, V> + * @return IterableMap<K, V> * @throws NullPointerException if map is null * @since 4.0 */ @@ -1782,7 +1782,7 @@ public class MapUtils { * @param <K> the key type * @param <V> the value type * @param sortedMap to wrap if necessary - * @return {@link IterableSortedMap}<K, V> + * @return {@link IterableSortedMap}<K, V> * @throws NullPointerException if sortedMap is null * @since 4.0 */ http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/Put.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/Put.java b/src/main/java/org/apache/commons/collections4/Put.java index fbd3971..b99f8b5 100644 --- a/src/main/java/org/apache/commons/collections4/Put.java +++ b/src/main/java/org/apache/commons/collections4/Put.java @@ -43,11 +43,19 @@ public interface Put<K, V> { * Note that the return type is Object, rather than V as in the Map interface. * See the class Javadoc for further info. * + * @param key key with which the specified value is to be associated + * @param value value to be associated with the specified key + * @return the previous value associated with <tt>key</tt>, or + * <tt>null</tt> if there was no mapping for <tt>key</tt>. + * (A <tt>null</tt> return can also indicate that the map + * previously associated <tt>null</tt> with <tt>key</tt>, + * if the implementation supports <tt>null</tt> values.) * @see Map#put(Object, Object) */ Object put(K key, V value); /** + * @param t mappings to be stored in this map * @see Map#putAll(Map) */ void putAll(Map<? extends K, ? extends V> t); http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/SetUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/SetUtils.java b/src/main/java/org/apache/commons/collections4/SetUtils.java index 5d305c2..3777fe8 100644 --- a/src/main/java/org/apache/commons/collections4/SetUtils.java +++ b/src/main/java/org/apache/commons/collections4/SetUtils.java @@ -163,10 +163,10 @@ public class SetUtils { * Returns a new hash set that matches elements based on <code>==</code> not * <code>equals()</code>. * <p> - * <strong>This set will violate the detail of various Set contracts.</note> + * <strong>This set will violate the detail of various Set contracts.</strong> * As a general rule, don't compare this set to other sets. In particular, you can't * use decorators like {@link ListOrderedSet} on it, which silently assume that these - * contracts are fulfilled.</strong> + * contracts are fulfilled. * <p> * <strong>Note that the returned set is not synchronized and is not thread-safe.</strong> * If you wish to use this set from multiple threads concurrently, you must use http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/SortedBidiMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/SortedBidiMap.java b/src/main/java/org/apache/commons/collections4/SortedBidiMap.java index 178090c..364f82f 100644 --- a/src/main/java/org/apache/commons/collections4/SortedBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/SortedBidiMap.java @@ -53,7 +53,7 @@ public interface SortedBidiMap<K, V> extends OrderedBidiMap<K, V>, SortedMap<K, /** * Get the comparator used for the values in the value-to-key map aspect. - * @return Comparator<? super V> + * @return Comparator<? super V> */ Comparator<? super V> valueComparator(); } http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/TransformerUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/TransformerUtils.java b/src/main/java/org/apache/commons/collections4/TransformerUtils.java index a68556b..9ecf426 100644 --- a/src/main/java/org/apache/commons/collections4/TransformerUtils.java +++ b/src/main/java/org/apache/commons/collections4/TransformerUtils.java @@ -117,10 +117,10 @@ public class TransformerUtils { * Gets a transformer that returns a clone of the input object. * The input object will be cloned using one of these techniques (in order): * <ul> - * <li>public clone method - * <li>public copy constructor - * <li>serialization clone - * <ul> + * <li>public clone method</li> + * <li>public copy constructor</li> + * <li>serialization clone</li> + * </ul> * * @param <T> the input/output type * @return the transformer @@ -267,7 +267,7 @@ public class TransformerUtils { * @return the transformer * @throws NullPointerException if either the predicate or transformer is null * @see SwitchTransformer - * @deprecated as of 4.1, use {@link #ifTransformer(Predicate, Transformer, Transformer)) + * @deprecated as of 4.1, use {@link #ifTransformer(Predicate, Transformer, Transformer)} */ @SuppressWarnings("unchecked") @Deprecated @@ -430,12 +430,14 @@ public class TransformerUtils { /** * Gets a Transformer that invokes a method on the input object. - * The method must have no parameters. If the input object is null, - * null is returned. + * The method must have no parameters. If the input object is {@code null}, + * {@code null} is returned. + * * <p> * For example, <code>TransformerUtils.invokerTransformer("getName");</code> - * will call the <code>getName/code> method on the input object to + * will call the <code>getName</code> method on the input object to * determine the transformer result. + * </p> * * @param <I> the input type * @param <O> the output type http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java index 28c4b7d..be6910a 100644 --- a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java @@ -71,7 +71,7 @@ public final class CollectionBag<E> extends AbstractBagDecorator<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(); @@ -82,8 +82,8 @@ public final class CollectionBag<E> extends AbstractBagDecorator<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/bag/CollectionSortedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java index 1baea2d..ea2a966 100644 --- a/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java @@ -63,7 +63,7 @@ public final class CollectionSortedBag<E> extends AbstractSortedBagDecorator<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(); @@ -74,8 +74,8 @@ public final class CollectionSortedBag<E> extends AbstractSortedBagDecorator<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/bag/HashBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/HashBag.java b/src/main/java/org/apache/commons/collections4/bag/HashBag.java index b2d64bb..2f5e997 100644 --- a/src/main/java/org/apache/commons/collections4/bag/HashBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/HashBag.java @@ -61,6 +61,9 @@ public class HashBag<E> extends AbstractMapBag<E> implements Serializable { //----------------------------------------------------------------------- /** * Write the bag 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(); @@ -69,6 +72,10 @@ public class HashBag<E> extends AbstractMapBag<E> implements Serializable { /** * Read the bag 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/bag/TreeBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/TreeBag.java b/src/main/java/org/apache/commons/collections4/bag/TreeBag.java index 016d67e..f0aeea6 100644 --- a/src/main/java/org/apache/commons/collections4/bag/TreeBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/TreeBag.java @@ -120,6 +120,9 @@ public class TreeBag<E> extends AbstractMapBag<E> implements SortedBag<E>, Seria //----------------------------------------------------------------------- /** * Write the bag 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(); @@ -129,6 +132,10 @@ public class TreeBag<E> extends AbstractMapBag<E> implements SortedBag<E>, Seria /** * Read the bag 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/bag/UnmodifiableBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java index 0f500e4..a583dbc 100644 --- a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java @@ -81,7 +81,7 @@ public final class UnmodifiableBag<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(); @@ -92,8 +92,8 @@ public final class UnmodifiableBag<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/bag/UnmodifiableSortedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java index 3560f3e..6761e58 100644 --- a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java @@ -78,7 +78,7 @@ public final class UnmodifiableSortedBag<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 UnmodifiableSortedBag<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/bidimap/TreeBidiMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java index 23adc3f..b7a9c1d 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java @@ -1431,6 +1431,10 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> /** * Reads the content of the stream. + * + * @param stream 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 */ @SuppressWarnings("unchecked") // This will fail at runtime if the stream is incorrect private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException{ @@ -1446,6 +1450,9 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> /** * Writes the content to the stream for serialization. + * + * @param stream the output stream + * @throws IOException if an error occurs while writing to the stream */ private void writeObject(final ObjectOutputStream stream) throws IOException{ stream.defaultWriteObject(); http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java b/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java index 3525b76..6f2256f 100644 --- a/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java +++ b/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java @@ -415,7 +415,7 @@ public class CompositeCollection<E> implements Collection<E>, Serializable { /** * Get the collection mutator to be used for this CompositeCollection. - * @return CollectionMutator<E> + * @return CollectionMutator<E> */ protected CollectionMutator<E> getMutator() { return mutator; http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java b/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java index e8e9a76..f0231a0 100644 --- a/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java +++ b/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java @@ -48,12 +48,13 @@ public final class BooleanComparator implements Comparator<Boolean>, Serializabl /** * Returns a BooleanComparator instance that sorts * <code>true</code> values before <code>false</code> values. - * <p /> + * <p> * Clients are encouraged to use the value returned from * this method instead of constructing a new instance * to reduce allocation and garbage collection overhead when * multiple BooleanComparators may be used in the same * virtual machine. + * </p> * * @return the true first singleton BooleanComparator */ @@ -64,12 +65,13 @@ public final class BooleanComparator implements Comparator<Boolean>, Serializabl /** * Returns a BooleanComparator instance that sorts * <code>false</code> values before <code>true</code> values. - * <p /> + * <p> * Clients are encouraged to use the value returned from * this method instead of constructing a new instance * to reduce allocation and garbage collection overhead when * multiple BooleanComparators may be used in the same * virtual machine. + * </p> * * @return the false first singleton BooleanComparator */ @@ -81,12 +83,13 @@ public final class BooleanComparator implements Comparator<Boolean>, Serializabl * Returns a BooleanComparator instance that sorts * <code><i>trueFirst</i></code> values before * <code>!<i>trueFirst</i></code> values. - * <p /> + * <p> * Clients are encouraged to use the value returned from * this method instead of constructing a new instance * to reduce allocation and garbage collection overhead when * multiple BooleanComparators may be used in the same * virtual machine. + * </p> * * @param trueFirst when <code>true</code>, sort * <code>true</code> <code>Boolean</code>s before <code>false</code> http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java b/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java index 38b7fe2..42a8e0f 100644 --- a/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/CatchAndRethrowClosure.java @@ -34,7 +34,7 @@ import org.apache.commons.collections4.FunctorException; * }; * * // use catch and re-throw closure - * java.util.List<String> strList = // some list + * java.util.List<String> strList = // some list * try { * CollectionUtils.forAllDo(strList, writer); * } catch (FunctorException ex) { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java b/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java index fd1d829..4d5474d 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java @@ -25,7 +25,7 @@ import org.apache.commons.collections4.Predicate; * Predicate that compares the input object with the one stored in the predicate using a comparator. * In addition, the comparator result can be evaluated in accordance to a supplied criterion value. * - * In order to demonstrate the use of the predicate, the following variables are declared: + * <p>In order to demonstrate the use of the predicate, the following variables are declared:</p> * * <pre> * Integer ONE = Integer.valueOf(1); @@ -40,14 +40,14 @@ import org.apache.commons.collections4.Predicate; * }; * </pre> * - * Using the declared variables, the <code>ComparatorPredicate</code> can be used used in the - * following way: + * <p>Using the declared variables, the <code>ComparatorPredicate</code> can be used used in the + * following way:</p> * * <pre> * ComparatorPredicate.comparatorPredicate(ONE, comparator).evaluate(TWO); * </pre> * - * The input variable <code>TWO</code> in compared to the stored variable <code>ONE</code> using + * <p>The input variable <code>TWO</code> in compared to the stored variable <code>ONE</code> using * the supplied <code>comparator</code>. This is the default usage of the predicate and will return * <code>true</code> if the underlying comparator returns <code>0</code>. In addition to the default * usage of the predicate, it is possible to evaluate the comparator's result in several ways. The @@ -62,16 +62,16 @@ import org.apache.commons.collections4.Predicate; * <li>LESS_OR_EQUAL</li> * </ul> * - * The following examples demonstrates how these constants can be used in order to manipulate the - * evaluation of a comparator result. + * <p>The following examples demonstrates how these constants can be used in order to manipulate the + * evaluation of a comparator result.</p> * * <pre> * ComparatorPredicate.comparatorPredicate(ONE, comparator,<b>ComparatorPredicate.Criterion.GREATER</b>).evaluate(TWO); * </pre> * - * The input variable TWO is compared to the stored variable ONE using the supplied <code>comparator</code> + * <p>The input variable TWO is compared to the stored variable ONE using the supplied <code>comparator</code> * using the <code>GREATER</code> evaluation criterion constant. This instructs the predicate to - * return <code>true</code> if the comparator returns a value greater than <code>0</code>. + * return <code>true</code> if the comparator returns a value greater than <code>0</code>.</p> * * @since 4.0 * @version $Id$ @@ -148,11 +148,11 @@ public class ComparatorPredicate<T> implements Predicate<T>, Serializable { * Evaluates the predicate. The predicate evaluates to <code>true</code> in the following cases: * * <ul> - * <li><code>comparator.compare(object, input) == 0 && criterion == EQUAL</code></li> - * <li><code>comparator.compare(object, input) < 0 && criterion == LESS</code></li> - * <li><code>comparator.compare(object, input) > 0 && criterion == GREATER</code></li> - * <li><code>comparator.compare(object, input) >= 0 && criterion == GREATER_OR_EQUAL</code></li> - * <li><code>comparator.compare(object, input) <= 0 && criterion == LESS_OR_EQUAL</code></li> + * <li><code>comparator.compare(object, input) == 0 && criterion == EQUAL</code></li> + * <li><code>comparator.compare(object, input) < 0 && criterion == LESS</code></li> + * <li><code>comparator.compare(object, input) > 0 && criterion == GREATER</code></li> + * <li><code>comparator.compare(object, input) >= 0 && criterion == GREATER_OR_EQUAL</code></li> + * <li><code>comparator.compare(object, input) <= 0 && criterion == LESS_OR_EQUAL</code></li> * </ul> * * @see org.apache.commons.collections4.Predicate#evaluate(java.lang.Object) http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java b/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java index 30b99c5..d10291a 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java @@ -47,7 +47,7 @@ public class ConstantTransformer<I, O> implements Transformer<I, O>, Serializabl * * @param <I> the input type * @param <O> the output type - * @return Transformer<I, O> that always returns null. + * @return Transformer<I, O> that always returns null. */ @SuppressWarnings("unchecked") // The null transformer works for all object types public static <I, O> Transformer<I, O> nullTransformer() { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java b/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java index 58fcf9d..6f68600 100644 --- a/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java @@ -48,7 +48,7 @@ public class InstantiateTransformer<T> implements Transformer<Class<? extends T> * Get a typed no-arg instance. * * @param <T> the type of the objects to be created - * @return Transformer<Class<? extends T>, T> + * @return Transformer<Class<? extends T>, T> */ @SuppressWarnings("unchecked") public static <T> Transformer<Class<? extends T>, T> instantiateTransformer() { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java index bde2878..199f96b 100644 --- a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java +++ b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java @@ -48,11 +48,13 @@ public class PrototypeFactory { * Creates a Factory that will return a clone of the same prototype object * each time the factory is used. The prototype will be cloned using one of these * techniques (in order): + * </p> + * * <ul> - * <li>public clone method - * <li>public copy constructor - * <li>serialization clone - * <ul> + * <li>public clone method</li> + * <li>public copy constructor</li> + * <li>serialization clone</li> + * </ul> * * @param <T> the type the factory creates * @param prototype the object to clone each time in the factory http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java index b5307d6..e6743ce 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java @@ -22,7 +22,7 @@ import java.util.NoSuchElementException; import org.apache.commons.collections4.ResettableListIterator; /** - * Implements a {@link ListIterator} over an array. + * Implements a {@link java.util.ListIterator} over an array. * <p> * The array can be either an array of object or of primitives. If you know * that you have an object array, the {@link ObjectArrayListIterator} @@ -177,9 +177,9 @@ public class ArrayListIterator<E> extends ArrayIterator<E> * This method sets the element that was returned by the last call * to {@link #next()} of {@link #previous()}. * <p> - * <b>Note:</b> {@link ListIterator} implementations that support + * <b>Note:</b> {@link java.util.ListIterator} implementations that support * <code>add()</code> and <code>remove()</code> only allow <code>set()</code> to be called - * once per call to <code>next()</code> or <code>previous</code> (see the {@link ListIterator} + * once per call to <code>next()</code> or <code>previous</code> (see the {@link java.util.ListIterator} * javadoc for more details). Since this implementation does * not support <code>add()</code> or <code>remove()</code>, <code>set()</code> may be * called as often as desired. http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java index 6f5b0c9..3d1ee36 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java @@ -49,7 +49,7 @@ public class EmptyIterator<E> extends AbstractEmptyIterator<E> implements Resett /** * Get a typed resettable empty iterator instance. * @param <E> the element type - * @return ResettableIterator<E> + * @return ResettableIterator<E> */ @SuppressWarnings("unchecked") public static <E> ResettableIterator<E> resettableEmptyIterator() { @@ -59,7 +59,7 @@ public class EmptyIterator<E> extends AbstractEmptyIterator<E> implements Resett /** * Get a typed empty iterator instance. * @param <E> the element type - * @return Iterator<E> + * @return Iterator<E> */ @SuppressWarnings("unchecked") public static <E> Iterator<E> emptyIterator() { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java index 6c6f8b4..909afa0 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java @@ -50,7 +50,7 @@ public class EmptyListIterator<E> extends AbstractEmptyIterator<E> implements /** * Get a typed instance of the iterator. * @param <E> the element type - * @return {@link ResettableListIterator}<E> + * @return {@link ResettableListIterator}<E> */ @SuppressWarnings("unchecked") public static <E> ResettableListIterator<E> resettableEmptyListIterator() { @@ -60,7 +60,7 @@ public class EmptyListIterator<E> extends AbstractEmptyIterator<E> implements /** * Get a typed instance of the iterator. * @param <E> the element type - * @return {@link ListIterator}<E> + * @return {@link ListIterator}<E> */ @SuppressWarnings("unchecked") public static <E> ListIterator<E> emptyListIterator() { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java index 90fee4a..813d582 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java @@ -39,7 +39,7 @@ public class EmptyMapIterator<K, V> extends AbstractEmptyMapIterator<K, V> imple * Get a typed instance of the iterator. * @param <K> the key type * @param <V> the value type - * @return {@link MapIterator}<K, V> + * @return {@link MapIterator}<K, V> */ @SuppressWarnings("unchecked") public static <K, V> MapIterator<K, V> emptyMapIterator() { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java index 200cae9..bfc2929 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java @@ -38,7 +38,7 @@ public class EmptyOrderedIterator<E> extends AbstractEmptyIterator<E> /** * Typed instance of the iterator. * @param <E> the element type - * @return OrderedIterator<E> + * @return OrderedIterator<E> */ @SuppressWarnings("unchecked") public static <E> OrderedIterator<E> emptyOrderedIterator() { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java index 6a5023b..dc5654e 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java @@ -39,7 +39,7 @@ public class EmptyOrderedMapIterator<K, V> extends AbstractEmptyMapIterator<K, V * Get a typed instance of the iterator. * @param <K> the key type * @param <V> the value type - * @return {@link OrderedMapIterator}<K, V> + * @return {@link OrderedMapIterator}<K, V> */ @SuppressWarnings("unchecked") public static <K, V> OrderedMapIterator<K, V> emptyOrderedMapIterator() { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java index 6bd0e43..15e513e 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java @@ -112,7 +112,10 @@ public class FilterListIterator<E> implements ListIterator<E> { } //----------------------------------------------------------------------- - /** Not supported. */ + /** + * Not supported. + * @param o the element to insert + */ @Override public void add(final E o) { throw new UnsupportedOperationException("FilterListIterator.add(Object) is not supported."); @@ -170,7 +173,11 @@ public class FilterListIterator<E> implements ListIterator<E> { throw new UnsupportedOperationException("FilterListIterator.remove() is not supported."); } - /** Not supported. */ + /** + * Not supported. + * @param o the element with which to replace the last element returned by + * {@code next} or {@code previous} + */ @Override public void set(final E o) { throw new UnsupportedOperationException("FilterListIterator.set(Object) is not supported."); http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java b/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java index b26e089..59c6edd 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java +++ b/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java @@ -28,11 +28,12 @@ import org.apache.commons.collections4.ResettableIterator; * operations use the same, exhausted source iterator. To create a single use * iterable, construct a new {@link IteratorIterable} using a {@link Iterator} * that is NOT a {@link ResettableIterator} iterator: + * </p> + * * <pre> - * Iterator<Integer> iterator = // some non-resettable iterator - * Iterable<Integer> iterable = new IteratorIterable<Integer>(iterator); + * Iterator<Integer> iterator = // some non-resettable iterator + * Iterable<Integer> iterable = new IteratorIterable<Integer>(iterator); * </pre> - * </p> * * <p> * In the multiple use iterable case, the iterable is usable for any number of @@ -40,22 +41,24 @@ import org.apache.commons.collections4.ResettableIterator; * the iterable supports multiple iterations, it does not support concurrent * iterations. To implicitly create a multiple use iterable, construct a new * {@link IteratorIterable} using a {@link ResettableIterator} iterator: + * </p> + * * <pre> * Integer[] array = {Integer.valueOf(1),Integer.valueOf(2),Integer.valueOf(3)}; - * Iterator<Integer> iterator = IteratorUtils.arrayIterator(array); // a resettable iterator - * Iterable<Integer> iterable = new IteratorIterable<Integer>(iterator); + * Iterator<Integer> iterator = IteratorUtils.arrayIterator(array); // a resettable iterator + * Iterable<Integer> iterable = new IteratorIterable<Integer>(iterator); * </pre> - * </p> * * <p> * A multiple use iterable can also be explicitly constructed using any * {@link Iterator} and specifying <code>true</code> for the * <code>multipleUse</code> flag: + * </p> + * * <pre> - * Iterator<Integer> iterator = // some non-resettable iterator - * Iterable<Integer> iterable = new IteratorIterable<Integer>(iterator, true); + * Iterator<Integer> iterator = // some non-resettable iterator + * Iterable<Integer> iterable = new IteratorIterable<Integer>(iterator, true); * </pre> - * </p> * * @since 4.0 * @version $Id$ http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java index b107f6e..c6196ef 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java @@ -21,7 +21,7 @@ import java.util.NoSuchElementException; import org.apache.commons.collections4.ResettableListIterator; /** - * Implements a {@link ListIterator} over an array of objects. + * Implements a {@link java.util.ListIterator} over an array of objects. * <p> * This iterator does not support {@link #add} or {@link #remove}, as the object array * cannot be structurally modified. The {@link #set} method is supported however. @@ -168,9 +168,9 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E> * This method sets the element that was returned by the last call * to {@link #next()} of {@link #previous()}. * - * <b>Note:</b> {@link ListIterator} implementations that support <code>add()</code> + * <b>Note:</b> {@link java.util.ListIterator} implementations that support <code>add()</code> * and <code>remove()</code> only allow <code>set()</code> to be called once per call - * to <code>next()</code> or <code>previous</code> (see the {@link ListIterator} + * to <code>next()</code> or <code>previous</code> (see the {@link java.util.ListIterator} * javadoc for more details). Since this implementation does not support * <code>add()</code> or <code>remove()</code>, <code>set()</code> may be * called as often as desired. http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java b/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java index df15e8b..2941a81 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java @@ -21,7 +21,7 @@ import java.util.NoSuchElementException; import org.apache.commons.collections4.ResettableIterator; /** - * <code>SingletonIterator</code> is an {@link Iterator} over a single + * <code>SingletonIterator</code> is an {@link java.util.Iterator} over a single * object instance. * * @since 2.0 http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java index 5dab9b8..736132e 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java @@ -21,7 +21,7 @@ import java.util.NoSuchElementException; import org.apache.commons.collections4.ResettableListIterator; /** - * <code>SingletonIterator</code> is an {@link ListIterator} over a single + * <code>SingletonIterator</code> is an {@link java.util.ListIterator} over a single * object instance. * * @since 2.1 http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java b/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java index 2afd8bb..61dc970 100644 --- a/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java +++ b/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java @@ -49,7 +49,7 @@ public abstract class AbstractSerializableListDecorator<E> * Write the list 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 AbstractSerializableListDecorator<E> * Read the list 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/list/CursorableLinkedList.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java index 101bf43..46c504e 100644 --- a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java +++ b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java @@ -363,6 +363,9 @@ public class CursorableLinkedList<E> extends AbstractLinkedList<E> implements Se //----------------------------------------------------------------------- /** * Serializes the data held in this object to the stream specified. + * + * @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(); @@ -371,6 +374,10 @@ public class CursorableLinkedList<E> extends AbstractLinkedList<E> implements Se /** * Deserializes the data held in this object to the stream specified. + * + * @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/list/NodeCachingLinkedList.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java b/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java index eb919c7..bb5fd2c 100644 --- a/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java +++ b/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java @@ -227,6 +227,9 @@ public class NodeCachingLinkedList<E> extends AbstractLinkedList<E> implements S //----------------------------------------------------------------------- /** * Serializes the data held in this object to the stream specified. + * + * @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(); @@ -235,6 +238,10 @@ public class NodeCachingLinkedList<E> extends AbstractLinkedList<E> implements S /** * Deserializes the data held in this object to the stream specified. + * + * @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/AbstractInputCheckedMapDecorator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractInputCheckedMapDecorator.java b/src/main/java/org/apache/commons/collections4/map/AbstractInputCheckedMapDecorator.java index a2b1959..0ba6d6e 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractInputCheckedMapDecorator.java +++ b/src/main/java/org/apache/commons/collections4/map/AbstractInputCheckedMapDecorator.java @@ -30,14 +30,17 @@ import org.apache.commons.collections4.set.AbstractSetDecorator; * <p> * The Map API is very difficult to decorate correctly, and involves implementing * lots of different classes. This class exists to provide a simpler API. + * </p> * <p> * Special hook methods are provided that are called when objects are added to * the map. By overriding these methods, the input can be validated or manipulated. * In addition to the main map methods, the entrySet is also affected, which is * the hardest part of writing map implementations. + * </p> * <p> * This class is package-scoped, and may be withdrawn or replaced in future * versions of Commons Collections. + * </p> * * @since 3.1 * @version $Id$ @@ -68,10 +71,13 @@ abstract class AbstractInputCheckedMapDecorator<K, V> * <p> * An implementation may validate the value and throw an exception * or it may transform the value into another object. + * </p> * <p> * This implementation returns the input value. + * </p> * * @param value the value to check + * @return the input value * @throws UnsupportedOperationException if the map may not be changed by setValue * @throws IllegalArgumentException if the specified value is invalid * @throws ClassCastException if the class of the specified value is invalid http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java index d06d5cb..0d6967e 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java @@ -75,7 +75,7 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im * Constructor which performs no validation on the passed in parameters. * * @param initialCapacity the initial capacity, must be a power of two - * @param loadFactor the load factor, must be > 0.0f and generally < 1.0f + * @param loadFactor the load factor, must be > 0.0f and generally < 1.0f * @param threshold the threshold, must be sensible */ protected AbstractLinkedMap(final int initialCapacity, final float loadFactor, final int threshold) { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java b/src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java index bd6e2e4..176f6f3 100644 --- a/src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java +++ b/src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java @@ -46,16 +46,18 @@ import java.util.Map; * returns <code>"Four".</code> The <code>Set</code> returned by <code>keySet()</code> * equals <code>{"one", "two", null}.</code> * <p> - * <strong>This map will violate the detail of various Map and map view contracts.</note> + * <strong>This map will violate the detail of various Map and map view contracts.</strong> * As a general rule, don't compare this map to other maps. In particular, you can't * use decorators like {@link ListOrderedMap} on it, which silently assume that these * contracts are fulfilled. + * </p> * <p> * <strong>Note that CaseInsensitiveMap 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(Map)}. This class may throw * exceptions when accessed by concurrent threads without synchronization. + * </p> * * @since 3.0 * @version $Id$ @@ -144,6 +146,9 @@ public class CaseInsensitiveMap<K, V> extends AbstractHashedMap<K, V> implements /** * 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(); @@ -152,6 +157,10 @@ public class CaseInsensitiveMap<K, V> extends AbstractHashedMap<K, V> implements /** * 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/DefaultedMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/DefaultedMap.java b/src/main/java/org/apache/commons/collections4/map/DefaultedMap.java index 47a1e8a..faddcdf 100644 --- a/src/main/java/org/apache/commons/collections4/map/DefaultedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/DefaultedMap.java @@ -174,7 +174,7 @@ public class DefaultedMap<K, V> extends AbstractMapDecorator<K, V> implements Se * 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(); @@ -185,8 +185,8 @@ public class DefaultedMap<K, V> extends AbstractMapDecorator<K, V> implements Se * 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") 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/map/EntrySetToMapIteratorAdapter.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java index 5b0e10f..d100a40 100644 --- a/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java +++ b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java @@ -109,7 +109,7 @@ public class EntrySetToMapIteratorAdapter<K, V> implements MapIterator<K, V>, Re /** * Get the currently active entry. - * @return Map.Entry<K, V> + * @return Map.Entry<K, V> */ protected synchronized Map.Entry<K, V> current() { if (entry == null) { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/f98ef6d3/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java b/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java index 4768b91..b909aef 100644 --- a/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java +++ b/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java @@ -89,7 +89,7 @@ public class FixedSizeMap<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 { @@ -101,8 +101,8 @@ public class FixedSizeMap<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/FixedSizeSortedMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java b/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java index ac6feeb..f57e8e9 100644 --- a/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java @@ -98,6 +98,9 @@ public class FixedSizeSortedMap<K, V> //----------------------------------------------------------------------- /** * 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(); @@ -106,6 +109,10 @@ public class FixedSizeSortedMap<K, V> /** * 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 */ @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/map/Flat3Map.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java index 62d91f9..dcce62a 100644 --- a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java +++ b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java @@ -1108,6 +1108,9 @@ public class Flat3Map<K, V> implements IterableMap<K, V>, Serializable, Cloneabl //----------------------------------------------------------------------- /** * 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(); @@ -1120,6 +1123,10 @@ public class Flat3Map<K, V> implements IterableMap<K, V>, Serializable, Cloneabl /** * 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 */ @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/map/HashedMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/HashedMap.java b/src/main/java/org/apache/commons/collections4/map/HashedMap.java index fb6863a..9c66adc 100644 --- a/src/main/java/org/apache/commons/collections4/map/HashedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/HashedMap.java @@ -98,6 +98,9 @@ public class HashedMap<K, V> /** * 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(); @@ -106,6 +109,10 @@ public class HashedMap<K, V> /** * 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/LRUMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/LRUMap.java b/src/main/java/org/apache/commons/collections4/map/LRUMap.java index b7c2dc8..e05d26d 100644 --- a/src/main/java/org/apache/commons/collections4/map/LRUMap.java +++ b/src/main/java/org/apache/commons/collections4/map/LRUMap.java @@ -198,8 +198,8 @@ public class LRUMap<K, V> /** * Constructor copying elements from another map. - * <p/> - * The maximum size is set from the map's size. + * + * <p>The maximum size is set from the map's size.</p> * * @param map the map to copy * @param scanUntilRemovable scan until a removeable entry is found, default false @@ -482,6 +482,9 @@ public class LRUMap<K, V> /** * 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(); @@ -490,6 +493,10 @@ public class LRUMap<K, V> /** * 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/LazyMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/LazyMap.java b/src/main/java/org/apache/commons/collections4/map/LazyMap.java index e254f08..b46a156 100644 --- a/src/main/java/org/apache/commons/collections4/map/LazyMap.java +++ b/src/main/java/org/apache/commons/collections4/map/LazyMap.java @@ -133,7 +133,7 @@ public class LazyMap<K, V> extends AbstractMapDecorator<K, V> implements Seriali * 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 { @@ -145,8 +145,8 @@ public class LazyMap<K, V> extends AbstractMapDecorator<K, V> implements Seriali * 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/LinkedMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/LinkedMap.java b/src/main/java/org/apache/commons/collections4/map/LinkedMap.java index d025282..6c5db90 100644 --- a/src/main/java/org/apache/commons/collections4/map/LinkedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/LinkedMap.java @@ -118,6 +118,9 @@ public class LinkedMap<K, V> extends AbstractLinkedMap<K, V> implements Serializ /** * 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(); @@ -126,6 +129,10 @@ public class LinkedMap<K, V> extends AbstractLinkedMap<K, V> implements Serializ /** * 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/ListOrderedMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java b/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java index 4511e01..b8de298 100644 --- a/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java @@ -128,7 +128,7 @@ public class ListOrderedMap<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 { @@ -140,8 +140,8 @@ public class ListOrderedMap<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/MultiKeyMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java b/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java index be4ccbf..093e74f 100644 --- a/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java +++ b/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java @@ -885,7 +885,7 @@ public class MultiKeyMap<K, V> extends AbstractMapDecorator<MultiKey<? extends K * 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(); @@ -896,8 +896,8 @@ public class MultiKeyMap<K, V> extends AbstractMapDecorator<MultiKey<? extends K * 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") 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/map/MultiValueMap.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java b/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java index 58c2bf0..7d4ee9a 100644 --- a/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java +++ b/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java @@ -156,7 +156,7 @@ public class MultiValueMap<K, V> extends AbstractMapDecorator<K, Object> impleme * 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 4.0 */ private void writeObject(final ObjectOutputStream out) throws IOException { @@ -168,8 +168,8 @@ public class MultiValueMap<K, V> extends AbstractMapDecorator<K, Object> impleme * 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 4.0 */ @SuppressWarnings("unchecked") // (1) should only fail if input stream is incorrect
