jcabi#37 - Limitation: Encapsulated objects with exposed mutators can…

… mutate their state

README.md

@@ -14,6 +14,10 @@ More details are here: [immutable.jcabi.com](http://immutable.jcabi.com/index.ht
 This module contains truly immutable collections of objects, including
 `Array`, `ArraySet`, and `ArrayMap`.
 
+## Limitation
+
+Encapsulated objects with exposed mutators can mutate their state.
+
 ## Questions?
 
 If you have any questions about the framework, or something doesn't work as expected,

src/main/java/com/jcabi/immutable/Array.java

@@ -45,6 +45,8 @@
  * <p>This class is truly immutable. This means that it never changes
  * its encapsulated values and is annotated with {@code @Immutable}
  * annotation.
+ * <p>
+ * Limitation: Encapsulated objects with exposed mutators can mutate their state.
  *
  * @param <T> Value key type
  * @author Yegor Bugayenko ([email protected])

src/main/java/com/jcabi/immutable/ArrayMap.java

@@ -51,6 +51,8 @@
  * <p>This class is truly immutable. This means that it never changes
  * its encapsulated values and is annotated with {@code @Immutable}
  * annotation.
+ * <p>
+ * Limitation: Encapsulated objects with exposed mutators can mutate their state.
  *
  * @param <K> Map key type
  * @param <V> Value key type

src/main/java/com/jcabi/immutable/ArraySet.java

@@ -45,6 +45,8 @@
  * <p>This class is truly immutable. This means that it never changes
  * its encapsulated values and is annotated with {@code @Immutable}
  * annotation.
+ * <p>
+ * Limitation: Encapsulated objects with exposed mutators can mutate their state.
  *
  * @param <T> Value key type
  * @author Yegor Bugayenko ([email protected])

src/main/java/com/jcabi/immutable/ArraySortedSet.java

@@ -47,6 +47,8 @@
  * <p>This class is truly immutable. This means that it never changes
  * its encapsulated values and is annotated with {@code @Immutable}
  * annotation.
+ * <p>
+ * Limitation: Encapsulated objects with exposed mutators can mutate their state.
  *
  * @param <T> Value key type
  * @author Yegor Bugayenko ([email protected])

src/site/apt/index.apt.vm

@@ -69,6 +69,10 @@ Immutable Collections
 </dependency>
 +--
 
+Limitation
+
+  Encapsulated objects with exposed mutators can mutate their state.
+
 * Cutting Edge Version
 
   If you want to use current version of the product, you can do it with