Author: tn
Date: Tue May 14 20:02:25 2013
New Revision: 1482544
URL: http://svn.apache.org/r1482544
Log:
[COLLECTIONS-461] Added javadoc clarification to Put. Thanks to mbenson.
Modified:
commons/proper/collections/trunk/RELEASE-NOTES.txt
commons/proper/collections/trunk/src/changes/changes.xml
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/Put.java
Modified: commons/proper/collections/trunk/RELEASE-NOTES.txt
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/RELEASE-NOTES.txt?rev=1482544&r1=1482543&r2=1482544&view=diff
==============================================================================
--- commons/proper/collections/trunk/RELEASE-NOTES.txt (original)
+++ commons/proper/collections/trunk/RELEASE-NOTES.txt Tue May 14 20:02:25 2013
@@ -179,6 +179,8 @@ Changed classes / methods
Fixed Bugs
----------
+ o [COLLECTIONS-461] Added additional clarification to javadoc of interface
"Put" wrt return type of
+ "put(Object, Object)" method. Thanks to Matt Benson,
sebb.
o [COLLECTIONS-447] Tree traversal with a TreeListIterator will not be
affected anymore by the removal of an element directly after
a call to previous(). Thanks to Jeffrey Barnes.
o [COLLECTIONS-445] Adapt and/or ignore several unit tests when run on a IBM
J9 VM (specification version 1.6.0) due to a faulty
Modified: commons/proper/collections/trunk/src/changes/changes.xml
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/changes/changes.xml?rev=1482544&r1=1482543&r2=1482544&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/changes/changes.xml (original)
+++ commons/proper/collections/trunk/src/changes/changes.xml Tue May 14
20:02:25 2013
@@ -31,6 +31,10 @@
<action issue="COLLECTIONS-462" dev="tn" type="add" due-to="Andy Seaborne,
Claude Warren">
Added "PeekingIterator" decorator to support one-element lookahead
during iteration.
</action>
+ <action issue="COLLECTIONS-461" dev="tn" type="fix" due-to="Matt Benson,
sebb">
+ Added additional clarification to javadoc of interface "Put" wrt return
type of
+ "put(Object, Object)" method.
+ </action>
<action issue="COLLECTIONS-460" dev="tn" type="update">
Changed "IteratorChain" to use internally a "Queue" instead of a "List".
Iterators are
removed from the queue once used and can be garbage collected after
being exhausted.
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/Put.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/Put.java?rev=1482544&r1=1482543&r2=1482544&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/Put.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/Put.java
Tue May 14 20:02:25 2013
@@ -20,6 +20,12 @@ import java.util.Map;
/**
* The "write" subset of the {@link Map} interface.
+ * <p>
+ * NOTE: in the original {@link Map} interface, {@link Map#put(Object,
Object)} is known
+ * to have the same return type as {@link Map#get(Object)}, namely {@code V}.
{@link Put}
+ * makes no assumptions in this regard (there is no association with, nor even
knowledge
+ * of, a "reading" interface) and thus defines {@link #put(Object, Object)} as
returning
+ * {@link Object}.
*
* @since 4.0
* @version $Id$
