svn commit: r1477337 - /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java

[sc...@apache.org]

Author: schor
Date: Mon Apr 29 20:57:21 2013
New Revision: 1477337

URL: http://svn.apache.org/r1477337
Log:
[UIMA-2379] javadoc update only

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java?rev=1477337&r1=1477336&r2=1477337&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java Mon Apr 29 20:57:21 2013
@@ -128,11 +128,31 @@ public final class FSArray extends TOP i
     return outArray;
   }
 
+  /**
+   * Not supported, will throw UnsupportedOperationException
+   */
   public void copyFromArray(String[] src, int srcOffset, int destOffset, int length) {
     throw new UnsupportedOperationException();
   }
     
-
+  /**
+   * Copies an array of Feature Structures to an Array of Strings.
+   * The strings are the "toString()" representation of the feature structures, 
+   * which are probably something that looks like FeatureStructure@123456
+   * 
+   * @param srcOffset
+   *                The index of the first element to copy.
+   * @param dest
+   *                The array to copy to.
+   * @param destOffset
+   *                Where to start copying into <code>dest</code>.
+   * @param length
+   *                The number of elements to copy.
+   * @exception ArrayIndexOutOfBoundsException
+   *                    If <code>srcOffset &lt; 0</code> or
+   *                    <code>length > size()</code> or
+   *                    <code>destOffset + length > destArray.length</code>.
+   */
   public void copyToArray(int srcOffset, String[] dest, int destOffset, int length) {
     CASImpl ll = jcasType.casImpl;
     ll.checkArrayBounds(addr, srcOffset, length);