Stating in the class javadoc that attempts to modify the object's state will result in an UnsupportedOperationException as requested in COLLECTIONS-303

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@687995 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/collections/bag/UnmodifiableBag.java

@@ -33,6 +33,8 @@ import org.apache.commons.collections.set.UnmodifiableSet;
  * 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$

src/java/org/apache/commons/collections/bag/UnmodifiableSortedBag.java

@@ -33,6 +33,8 @@ import org.apache.commons.collections.set.UnmodifiableSet;
  * 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$

src/java/org/apache/commons/collections/bidimap/UnmodifiableBidiMap.java

@@ -30,6 +30,8 @@ import org.apache.commons.collections.set.UnmodifiableSet;
 
 /**
  * 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$

src/java/org/apache/commons/collections/bidimap/UnmodifiableOrderedBidiMap.java

@@ -32,6 +32,8 @@ import org.apache.commons.collections.set.UnmodifiableSet;
 
 /**
  * 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$

src/java/org/apache/commons/collections/bidimap/UnmodifiableSortedBidiMap.java

@@ -35,6 +35,8 @@ import org.apache.commons.collections.set.UnmodifiableSet;
 
 /**
  * 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$

src/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java

@@ -31,6 +31,8 @@ import org.apache.commons.collections.iterators.UnmodifiableIterator;
  * 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$

src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java

@@ -33,6 +33,8 @@ import org.apache.commons.collections.iterators.UnmodifiableIterator;
  * 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$

src/java/org/apache/commons/collections/collection/UnmodifiableCollection.java

@@ -26,6 +26,8 @@ import org.apache.commons.collections.iterators.UnmodifiableIterator;
  * 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$

src/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java

@@ -22,6 +22,8 @@ import org.apache.commons.collections.Unmodifiable;
 
 /** 
  * 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$

src/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java

@@ -22,6 +22,8 @@ import org.apache.commons.collections.Unmodifiable;
 
 /** 
  * 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$

src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java

@@ -21,6 +21,8 @@ import org.apache.commons.collections.Unmodifiable;
 
 /** 
  * 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$

src/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java

@@ -21,6 +21,8 @@ import org.apache.commons.collections.Unmodifiable;
 
 /** 
  * 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$

src/java/org/apache/commons/collections/list/UnmodifiableList.java

@@ -29,6 +29,8 @@ import org.apache.commons.collections.iterators.UnmodifiableListIterator;
  * 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$

src/java/org/apache/commons/collections/map/UnmodifiableEntrySet.java

@@ -29,6 +29,8 @@ import org.apache.commons.collections.set.AbstractSetDecorator;
 
 /**
  * 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$

src/java/org/apache/commons/collections/map/UnmodifiableMap.java

@@ -36,6 +36,8 @@ import org.apache.commons.collections.set.UnmodifiableSet;
  * 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$

src/java/org/apache/commons/collections/map/UnmodifiableOrderedMap.java

@@ -37,6 +37,8 @@ import org.apache.commons.collections.set.UnmodifiableSet;
  * 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$

src/java/org/apache/commons/collections/map/UnmodifiableSortedMap.java

@@ -34,6 +34,8 @@ import org.apache.commons.collections.set.UnmodifiableSet;
  * 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$

src/java/org/apache/commons/collections/set/UnmodifiableSet.java

@@ -27,6 +27,8 @@ import org.apache.commons.collections.iterators.UnmodifiableIterator;
  * 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$

src/java/org/apache/commons/collections/set/UnmodifiableSortedSet.java

@@ -31,6 +31,8 @@ import org.apache.commons.collections.iterators.UnmodifiableIterator;
  * 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$