Author: bayard
Date: Fri Aug 22 00:21:18 2008
New Revision: 687995

URL: http://svn.apache.org/viewvc?rev=687995&view=rev
Log:
Stating in the class javadoc that attempts to modify the object's state will 
result in an UnsupportedOperationException as requested in COLLECTIONS-303

Modified:
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableBag.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableSortedBag.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableBidiMap.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableOrderedBidiMap.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableSortedBidiMap.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableCollection.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/list/UnmodifiableList.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableEntrySet.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableMap.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableOrderedMap.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableSortedMap.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSet.java
    
commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSortedSet.java

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableBag.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableBag.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableBag.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableBag.java
 Fri Aug 22 00:21:18 2008
@@ -33,6 +33,8 @@
  * Decorates another <code>Bag</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableSortedBag.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableSortedBag.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableSortedBag.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bag/UnmodifiableSortedBag.java
 Fri Aug 22 00:21:18 2008
@@ -33,6 +33,8 @@
  * Decorates another <code>SortedBag</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableBidiMap.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableBidiMap.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableBidiMap.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableBidiMap.java
 Fri Aug 22 00:21:18 2008
@@ -30,6 +30,8 @@
 
 /**
  * Decorates another <code>BidiMap</code> to ensure it can't be altered.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableOrderedBidiMap.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableOrderedBidiMap.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableOrderedBidiMap.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableOrderedBidiMap.java
 Fri Aug 22 00:21:18 2008
@@ -32,6 +32,8 @@
 
 /**
  * Decorates another <code>OrderedBidiMap</code> to ensure it can't be altered.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableSortedBidiMap.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableSortedBidiMap.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableSortedBidiMap.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/bidimap/UnmodifiableSortedBidiMap.java
 Fri Aug 22 00:21:18 2008
@@ -35,6 +35,8 @@
 
 /**
  * Decorates another <code>SortedBidiMap</code> to ensure it can't be altered.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java
 Fri Aug 22 00:21:18 2008
@@ -31,6 +31,8 @@
  * Decorates another <code>Buffer</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java
 Fri Aug 22 00:21:18 2008
@@ -33,6 +33,8 @@
  * examining the package scope variables.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableCollection.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableCollection.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableCollection.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/collection/UnmodifiableCollection.java
 Fri Aug 22 00:21:18 2008
@@ -26,6 +26,8 @@
  * Decorates another <code>Collection</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
 Fri Aug 22 00:21:18 2008
@@ -22,6 +22,8 @@
 
 /** 
  * Decorates an iterator such that it cannot be modified.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
 Fri Aug 22 00:21:18 2008
@@ -22,6 +22,8 @@
 
 /** 
  * Decorates a list iterator such that it cannot be modified.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
 Fri Aug 22 00:21:18 2008
@@ -21,6 +21,8 @@
 
 /** 
  * Decorates a map iterator such that it cannot be modified.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
 Fri Aug 22 00:21:18 2008
@@ -21,6 +21,8 @@
 
 /** 
  * Decorates an ordered map iterator such that it cannot be modified.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/list/UnmodifiableList.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/list/UnmodifiableList.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/list/UnmodifiableList.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/list/UnmodifiableList.java
 Fri Aug 22 00:21:18 2008
@@ -29,6 +29,8 @@
  * Decorates another <code>List</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableEntrySet.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableEntrySet.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableEntrySet.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableEntrySet.java
 Fri Aug 22 00:21:18 2008
@@ -29,6 +29,8 @@
 
 /**
  * Decorates a map entry <code>Set</code> to ensure it can't be altered.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableMap.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableMap.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableMap.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableMap.java
 Fri Aug 22 00:21:18 2008
@@ -36,6 +36,8 @@
  * Decorates another <code>Map</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableOrderedMap.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableOrderedMap.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableOrderedMap.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableOrderedMap.java
 Fri Aug 22 00:21:18 2008
@@ -37,6 +37,8 @@
  * Decorates another <code>OrderedMap</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableSortedMap.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableSortedMap.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableSortedMap.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/UnmodifiableSortedMap.java
 Fri Aug 22 00:21:18 2008
@@ -34,6 +34,8 @@
  * Decorates another <code>SortedMap</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSet.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSet.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSet.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSet.java
 Fri Aug 22 00:21:18 2008
@@ -27,6 +27,8 @@
  * Decorates another <code>Set</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$

Modified: 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSortedSet.java
URL: 
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSortedSet.java?rev=687995&r1=687994&r2=687995&view=diff
==============================================================================
--- 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSortedSet.java
 (original)
+++ 
commons/proper/collections/trunk/src/java/org/apache/commons/collections/set/UnmodifiableSortedSet.java
 Fri Aug 22 00:21:18 2008
@@ -31,6 +31,8 @@
  * Decorates another <code>SortedSet</code> to ensure it can't be altered.
  * <p>
  * This class is Serializable from Commons Collections 3.1.
+ * <p>
+ * Attempts to modify it will result in an UnsupportedOperationException. 
  *
  * @since Commons Collections 3.0
  * @version $Revision$ $Date$


Reply via email to