svn commit: r573581 - /incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java

[tw...@apache.org]

Author: twgoetz
Date: Fri Sep  7 06:38:34 2007
New Revision: 573581

URL: http://svn.apache.org/viewvc?rev=573581&view=rev
Log:
Jira UIMA-301: javadoc update.

https://issues.apache.org/jira/browse/UIMA-301

Modified:
    incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java

Modified: incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java?rev=573581&r1=573580&r2=573581&view=diff
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java Fri Sep  7 06:38:34 2007
@@ -42,38 +42,41 @@
    * Copy the contents of the array to an external string array.
    * 
    * @param srcOffset
-   *          The index of the first element to copy.
+   *                The index of the first element to copy.
    * @param dest
-   *          The array to copy to.
+   *                The array to copy to.
    * @param destOffset
-   *          Where to start copying into <code>dest</code>.
+   *                Where to start copying into <code>dest</code>.
    * @param length
-   *          The number of elements to copy.
+   *                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>.
+   *                    If <code>srcOffset &lt; 0</code> or
+   *                    <code>length > size()</code> or
+   *                    <code>destOffset + length > destArray.length</code>.
    */
   void copyToArray(int srcOffset, String[] dest, int destOffset, int length)
-          throws ArrayIndexOutOfBoundsException;
+      throws ArrayIndexOutOfBoundsException;
 
   /**
-   * Copy the contents of an external string array into this array. The strings are parsed and
-   * converted to floats.
+   * Copy the contents of an external string array into this array. The strings
+   * are parsed and converted to floats.
    * 
    * @param src
-   *          The source array.
+   *                The source array.
    * @param srcOffset
-   *          Where to start copying in the source array.
+   *                Where to start copying in the source array.
    * @param destOffset
-   *          Where to start copying to in the destination array.
+   *                Where to start copying to in the destination array.
    * @param length
-   *          The number of elements to copy.
+   *                The number of elements to copy.
    * @exception ArrayIndexOutOfBoundsException
-   *              When length conditions are not met.
+   *                    When length conditions are not met.
    * @exception NumberFormatException
-   *              When the input strings do not represent valid floats.
+   *                    When the input strings do not represent valid floats.
+   * @exception UnsupportedOperationException
+   *                    When the array is an array of FSs.
    */
   void copyFromArray(String[] src, int srcOffset, int destOffset, int length)
-          throws ArrayIndexOutOfBoundsException, NumberFormatException;
+      throws ArrayIndexOutOfBoundsException, NumberFormatException;
 
 }