svn commit: r1772778 - /uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/Id2FS.java

[sc...@apache.org]

Author: schor
Date: Mon Dec  5 20:09:47 2016
New Revision: 1772778

URL: http://svn.apache.org/viewvc?rev=1772778&view=rev
Log:
no jira - javadoc updates only

Modified:
    uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/Id2FS.java

Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/Id2FS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/Id2FS.java?rev=1772778&r1=1772777&r2=1772778&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/Id2FS.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/Id2FS.java Mon Dec  5 20:09:47 2016
@@ -37,6 +37,7 @@ import org.apache.uima.jcas.cas.TOP;
  *      won't prevent the FS from being GC'd.  
  * 
  * Removes not supported; they happen when the map is reset / cleared
+ * This corresponds to the v2 property of "once created, a FS cannot be reclaimed (until reset)"
  */
 public class Id2FS {
   static final boolean MEASURE = false;
@@ -66,6 +67,10 @@ public class Id2FS {
     assert prev == null;
   }
   
+  /**
+   * Skips the assert that the item wasn't already present
+   * @param fs the fs to add
+   */
   void putUnconditionally(TOP fs) {
     id2fs.put(fs._id, fs);
   }