You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2013/12/09 19:21:39 UTC
svn commit: r1549633 - in
/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima:
analysis_component/ analysis_engine/ analysis_engine/annotator/
analysis_engine/impl/ cas/
Author: schor
Date: Mon Dec 9 18:21:38 2013
New Revision: 1549633
URL: http://svn.apache.org/r1549633
Log:
[UIMA-3484] javadoc fixes
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/AnalysisComponent.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasAnnotator_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasMultiplier_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/AnnotatorContext.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/BaseAnnotator.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFullFeatNames.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/BooleanArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ByteArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/DoubleArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FeatureValuePath.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FloatArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/IntArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/LongArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ShortArrayFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaFS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/StringArrayFS.java
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/AnalysisComponent.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/AnalysisComponent.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/AnalysisComponent.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/AnalysisComponent.java Mon Dec 9 18:21:38 2013
@@ -67,9 +67,8 @@ import org.apache.uima.resource.Resource
* <li>The AnalysisComponent, in its <code>next</code> method, can create a new CAS by calling
* {@link UimaContext#getEmptyCas(Class)} (or instead, one of the helper methods in the ImplBase
* class that it extended). It then populates the empty CAS and returns it.</li>
- * <li>Steps 2 & 3 continue for each subsequent output CAS, until <code>hasNext()</code> returns
+ * <li>Steps 2 & 3 continue for each subsequent output CAS, until <code>hasNext()</code> returns
* false.</li>
- * </ul>
* </ol>
*
* From the time when <code>process</code> is called until the time when <code>hasNext</code>
@@ -77,7 +76,7 @@ import org.apache.uima.resource.Resource
* The AnalysisComponent is permitted to make changes to this CAS. Once <code>hasNext</code>
* returns false, the AnalysisComponent releases control of the initial CAS. This means that the
* AnalysisComponent must finish all updates to the initial CAS prior to returning false from
- * <code>hasNext<code>.
+ * <code>hasNext</code>.
* <p>
* However, if the <code>process</code> method is called a second time, before <code>hasNext</code> has returned
* false, this is a signal to the AnalysisComponent to cancel all processing of the previous CAS and begin
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasAnnotator_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasAnnotator_ImplBase.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasAnnotator_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasAnnotator_ImplBase.java Mon Dec 9 18:21:38 2013
@@ -82,6 +82,7 @@ public abstract class CasAnnotator_ImplB
* and Features to the actual {@link org.apache.uima.cas.Type} and
* {@link org.apache.uima.cas.Feature} objects, which can then be used during processing.
*
+ * @param aTypeSystem the new type system to use as input to your initialization
* @throws AnalysisEngineProcessException
* if the provided type system is missing types or features required by this annotator
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasMultiplier_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasMultiplier_ImplBase.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasMultiplier_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_component/CasMultiplier_ImplBase.java Mon Dec 9 18:21:38 2013
@@ -93,6 +93,7 @@ public abstract class CasMultiplier_Impl
* and Features to the actual {@link org.apache.uima.cas.Type} and
* {@link org.apache.uima.cas.Feature} objects, which can then be used during processing.
*
+ * @param aTypeSystem the new type system to use as input to your initialization
* @throws AnalysisEngineProcessException
* if the provided type system is missing types or features required by this annotator
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/AnalysisEngineDescription.java Mon Dec 9 18:21:38 2013
@@ -204,7 +204,7 @@ public interface AnalysisEngineDescripti
* indicate the delegate AnalysisEngines that comprise the aggregate.
* <p>
* This is a direct representation of what is in the XML syntax for the descriptor. That is, if
- * the XML had an <import> element, the Map will contain an <code>Import</code> object. If
+ * the XML had an <import> element, the Map will contain an <code>Import</code> object. If
* you do not want to deal with imports, use the {@link #getDelegateAnalysisEngineSpecifiers()}
* method instead.
*
@@ -376,13 +376,14 @@ public interface AnalysisEngineDescripti
* @param aWriter
* a Writer to which the XML string will be written
* @param aPreserveDelegateAnalysisEngineImports
- * if true, XML serialization will always preserve <import> elements used to import
+ * if true, XML serialization will always preserve <import> elements used to import
* delegate analysis engine specifiers into an aggregate. If false, the default import
- * serialization behavior applies, which is to write <import> elements only in the
+ * serialization behavior applies, which is to write <import> elements only in the
* case where they have not previously been resolved.
*
* @throws IOException
* if an I/O failure occurs
+ * @throws SAXException if a SAX exception occurs
*/
public void toXML(Writer aWriter, boolean aPreserveDelegateAnalysisEngineImports)
throws SAXException, IOException;
@@ -393,13 +394,14 @@ public interface AnalysisEngineDescripti
* @param aOutputStream
* an OutputStream to which the XML string will be written, in UTF-8 encoding.
* @param aPreserveDelegateAnalysisEngineImports
- * if true, XML serialization will always preserve <import> elements used to import
+ * if true, XML serialization will always preserve <import> elements used to import
* delegate analysis engine specifiers into an aggregate. If false, the default import
- * serialization behavior applies, which is to write <import> elements only in the
+ * serialization behavior applies, which is to write <import> elements only in the
* case where they have not previously been resolved.
*
* @throws IOException
* if an I/O failure occurs
+ * @throws SAXException if a SAX exception occurs
*/
public void toXML(OutputStream aOutputStream, boolean aPreserveDelegateAnalysisEngineImports)
throws SAXException, IOException;
@@ -414,13 +416,12 @@ public interface AnalysisEngineDescripti
* whether the namespace of this element should be written as the default namespace. This
* should be done only for the root element, and it defaults to false.
* @param aPreserveDelegateAnalysisEngineImports
- * if true, XML serialization will always preserve <import> elements used to import
+ * if true, XML serialization will always preserve <import> elements used to import
* delegate analysis engine specifiers into an aggregate. If false, the default import
- * serialization behavior applies, which is to write <import> elements only in the
+ * serialization behavior applies, which is to write <import> elements only in the
* case where they have not previously been resolved.
*
- * @throws IOException
- * if an I/O failure occurs
+ * @throws SAXException if a SAX exception occurs
*/
public void toXML(ContentHandler aContentHandler, boolean aWriteDefaultNamespaceAttribute,
boolean aPreserveDelegateAnalysisEngineImports) throws SAXException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/AnnotatorContext.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/AnnotatorContext.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/AnnotatorContext.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/AnnotatorContext.java Mon Dec 9 18:21:38 2013
@@ -155,7 +155,7 @@ public interface AnnotatorContext {
*
* @return the <code>URL</code> at which the named resource is located, <code>null</code> if
* the named resource could not be found.
- *
+ * @throws AnnotatorContextException if there's a problem
* @see org.apache.uima.UimaContext#getResourceURL(String)
*/
public URL getResourceURL(String aKey) throws AnnotatorContextException;
@@ -180,7 +180,7 @@ public interface AnnotatorContext {
*
* @return the <code>URI</code> at which the named resource is located, <code>null</code> if
* the named resource could not be found.
- *
+ * @throws AnnotatorContextException if there's an exception
* @see org.apache.uima.UimaContext#getResourceURI(String)
*/
public URI getResourceURI(String aKey) throws AnnotatorContextException;
@@ -207,7 +207,7 @@ public interface AnnotatorContext {
*
* @return the absolute file path at which the named resource is located, <code>null</code> if
* the named resource could not be found.
- *
+ * @throws AnnotatorContextException if there's an exception
*
* @see org.apache.uima.UimaContext#getResourceFilePath(String)
*/
@@ -230,6 +230,7 @@ public interface AnnotatorContext {
* @return an <code>InputStream</code> for reading from the named resource, <code>null</code>
* if the named resource could not be found. It is the caller's responsibility to close
* this stream once it is no longer needed.
+ * @throws AnnotatorContextException if an error occurs
*
* @see org.apache.uima.UimaContext#getResourceAsStream(String)
*/
@@ -245,6 +246,7 @@ public interface AnnotatorContext {
* <externalResourceDependencies> section of the descriptor.
*
* @return the object bound to <code>aName</code>, <code>null</code> if none.
+ * @throws AnnotatorContextException if an error occurs
*
* @see org.apache.uima.UimaContext#getResourceObject(String)
*/
@@ -267,7 +269,7 @@ public interface AnnotatorContext {
* <p>
* This version of this method takes an array of parameters used to further identify the resource.
* This can be used, for example, with resources that vary depending on the language of the
- * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
+ * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
* the component descriptor.
*
* @param aKey
@@ -275,11 +277,12 @@ public interface AnnotatorContext {
* <externalResourceDependencies> section of the descriptor.
* @param aParams
* parameters used to further identify the resource. When used to identify the language
- * for a <fileLanguageResourceSpecifier>, this array should contain a single element,
+ * for a <fileLanguageResourceSpecifier>, this array should contain a single element,
* the ISO language code for the language of the document (e.g. "en", "de").
*
* @return the <code>URL</code> at which the named resource is located, <code>null</code> if
* the named resource could not be found.
+ * @throws AnnotatorContextException if an error occurs
*
* @see org.apache.uima.UimaContext#getResourceURL(String,String[])
*/
@@ -301,16 +304,17 @@ public interface AnnotatorContext {
* <p>
* This version of this method takes an array of parameters used to further identify the resource.
* This can be used, for example, with resources that vary depending on the language of the
- * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
+ * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
* the component descriptor.
*
* @param aKey
* the key by which the resource is identified. This key should be declared in the
* <externalResourceDependencies> section of the descriptor.
- *
+ * @param aParams the additional parameters to further identify the resource
* @return the <code>URI</code> at which the named resource is located, <code>null</code> if
* the named resource could not be found.
*
+ * @throws AnnotatorContextException if an error occurs
* @see org.apache.uima.UimaContext#getResourceURI(String,String[])
*/
public URI getResourceURI(String aKey, String[] aParams) throws AnnotatorContextException;
@@ -333,15 +337,17 @@ public interface AnnotatorContext {
* <p>
* This version of this method takes an array of parameters used to further identify the resource.
* This can be used, for example, with resources that vary depending on the language of the
- * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
+ * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
* the component descriptor.
*
* @param aKey
* the key by which the resource is identified. This key should be declared in the
* <externalResourceDependencies> section of the descriptor.
+ * @param aParams The parameters used to further specify the resource
*
* @return the absolute file path at which the named resource is located, <code>null</code> if
* the named resource could not be found.
+ * @throws AnnotatorContextException if an error occurs
*
* @see org.apache.uima.UimaContext#getResourceFilePath(String,String[])
*/
@@ -359,7 +365,7 @@ public interface AnnotatorContext {
* <p>
* This version of this method takes an array of parameters used to further identify the resource.
* This can be used, for example, with resources that vary depending on the language of the
- * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
+ * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
* the component descriptor.
*
* @param aKey
@@ -367,12 +373,13 @@ public interface AnnotatorContext {
* <externalResourceDependencies> section of the descriptor.
* @param aParams
* parameters used to further identify the resource. When used to identify the language
- * for a <fileLanguageResourceSpecifier>, this array should contain a single element,
+ * for a <fileLanguageResourceSpecifier>, this array should contain a single element,
* the ISO language code for the language of the document (e.g. "en", "de").
*
* @return an <code>InputStream</code> for reading from the named resource, <code>null</code>
* if the named resource could not be found. It is the caller's responsibility to close
* this stream once it is no longer needed.
+ * @throws AnnotatorContextException if an error occurs
*
* @see org.apache.uima.UimaContext#getResourceAsStream(String,String[])
*/
@@ -386,7 +393,7 @@ public interface AnnotatorContext {
* <p>
* This version of this method takes an array of parameters used to further identify the resource.
* This can be used, for example, with resources that vary depending on the language of the
- * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
+ * document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in
* the component descriptor.
*
* @param aKey
@@ -394,10 +401,11 @@ public interface AnnotatorContext {
* <externalResourceDependencies> section of the descriptor.
* @param aParams
* parameters used to further identify the resource. When used to identify the language
- * for a <fileLanguageResourceSpecifier>, this array should contain a single element,
+ * for a <fileLanguageResourceSpecifier>, this array should contain a single element,
* the ISO language code for the language of the document (e.g. "en", "de").
*
* @return the object bound to <code>aName</code>, <code>null</code> if none.
+ * @throws AnnotatorContextException if an error occurs
*
* @see org.apache.uima.UimaContext#getResourceObject(String,String[])
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/BaseAnnotator.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/BaseAnnotator.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/BaseAnnotator.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/annotator/BaseAnnotator.java Mon Dec 9 18:21:38 2013
@@ -56,6 +56,7 @@ public interface BaseAnnotator {
* and Features to the actual {@link org.apache.uima.cas.Type} and
* {@link org.apache.uima.cas.Feature} objects, which can then be used during processing.
*
+ * @param aTypeSystem the new type system
* @throws AnnotatorInitializationException
* if the annotator cannot initialize itself.
* @throws AnnotatorConfigurationException
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFullFeatNames.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFullFeatNames.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFullFeatNames.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/analysis_engine/impl/RsFullFeatNames.java Mon Dec 9 18:21:38 2013
@@ -27,7 +27,7 @@ import org.apache.uima.cas.TypeSystem;
/**
* Implements a globally shared weak-reference map between
- * types & features to the corresponding Full Feature name
+ * types & features to the corresponding Full Feature name
* Used to avoid creating new full feature names when compiling
* result feature specs.
* Indexable for features via a 2 step index: typeName (weak) and shortFeatName
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ArrayFS.java Mon Dec 9 18:21:38 2013
@@ -36,7 +36,7 @@ public interface ArrayFS extends CommonA
/**
* Get the i-th feature structure from the array.
- *
+ * @param i index
* @return The i-th feature structure.
* @exception ArrayIndexOutOfBoundsException
* If the index is out of bounds.
@@ -68,8 +68,8 @@ public interface ArrayFS extends CommonA
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, FeatureStructure[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
@@ -85,6 +85,9 @@ public interface ArrayFS extends CommonA
* Where to start copying to in the destination array.
* @param length
* The number of elements to copy.
+ * @exception ArrayIndexOutOfBoundsException
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyFromArray(FeatureStructure[] src, int srcOffset, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/BooleanArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/BooleanArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/BooleanArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/BooleanArrayFS.java Mon Dec 9 18:21:38 2013
@@ -29,7 +29,7 @@ public interface BooleanArrayFS extends
/**
* Get the i-th string from the array.
- *
+ * @param i selects the string
* @return The i-th element.
* @exception ArrayIndexOutOfBoundsException
* If the index is out of bounds.
@@ -68,8 +68,8 @@ public interface BooleanArrayFS extends
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, boolean[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ByteArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ByteArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ByteArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ByteArrayFS.java Mon Dec 9 18:21:38 2013
@@ -30,6 +30,7 @@ public interface ByteArrayFS extends Com
/**
* Get the i-th string from the array.
*
+ * @param i the index
* @return The i-th element.
* @exception ArrayIndexOutOfBoundsException
* If the index is out of bounds.
@@ -68,8 +69,8 @@ public interface ByteArrayFS extends Com
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, byte[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CommonArrayFS.java Mon Dec 9 18:21:38 2013
@@ -51,8 +51,8 @@ public interface CommonArrayFS extends F
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
* If <code>srcOffset < 0</code> or
- * <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, String[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/DoubleArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/DoubleArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/DoubleArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/DoubleArrayFS.java Mon Dec 9 18:21:38 2013
@@ -29,7 +29,7 @@ public interface DoubleArrayFS extends C
/**
* Get the i-th element from the array.
- *
+ * @param i the index
* @return The i-th element.
* @exception ArrayIndexOutOfBoundsException
* If the index is out of bounds.
@@ -68,8 +68,8 @@ public interface DoubleArrayFS extends C
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, double[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FeatureValuePath.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FeatureValuePath.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FeatureValuePath.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FeatureValuePath.java Mon Dec 9 18:21:38 2013
@@ -37,7 +37,7 @@ import org.apache.uima.cas.impl.LowLevel
* CAS chunks)
* </ul>
*
- * <b>Handling of Arrays </b> <br/>
+ * <b>Handling of Arrays </b> <br>
* <ul>
* <li>A feature path may contain 0 or more features of type <code>FSArray</code>, but not as
* the last path snippet. The next path snippet must contain the fully qualified type name, example:
@@ -67,8 +67,8 @@ import org.apache.uima.cas.impl.LowLevel
* operator can be used directly. Unlike FSArray, this access operator must be the only entry in the
* path.
*
- * <br/><b>Usage </b>
- * <ul>
+ * <br><b>Usage </b>
+ * <ol>
* <li>To create the feature path, use <code>FeaturePath.getFeaturePath</code>. Note that the
* client code needs to keep track of the "start type" of the feature path, that is, the type that
* contains the attribute used in the first snippet of the path.
@@ -76,7 +76,7 @@ import org.apache.uima.cas.impl.LowLevel
* <code>typeSystemInit</code> of the feature path.
* <li>Call <code>getValueType</code> to find out whether the feature path evaluates to a String,
* and int, a float, or their array counterparts.
- * <li>Depending on the leaf type, call the appropriate <coce>evaluateAs </code> methods
+ * <li>Depending on the leaf type, call the appropriate <code>evaluateAs </code> methods
* </ol>
*
* @deprecated use {@link org.apache.uima.cas.FeaturePath FeaturePath}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FloatArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FloatArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FloatArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FloatArrayFS.java Mon Dec 9 18:21:38 2013
@@ -29,7 +29,7 @@ public interface FloatArrayFS extends Co
/**
* Get the element at position <code>index</code>.
- *
+ * @param index the index
* @return The element.
* @exception ArrayIndexOutOfBoundsException
* If <code>index</code> is out of bounds.
@@ -60,8 +60,8 @@ public interface FloatArrayFS extends Co
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, float[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/IntArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/IntArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/IntArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/IntArrayFS.java Mon Dec 9 18:21:38 2013
@@ -29,7 +29,7 @@ public interface IntArrayFS extends Comm
/**
* Get the element at position <code>index</code>.
- *
+ * @param index the index
* @return The element.
* @exception ArrayIndexOutOfBoundsException
* If <code>index</code> is out of bounds.
@@ -61,8 +61,8 @@ public interface IntArrayFS extends Comm
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, int[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/LongArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/LongArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/LongArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/LongArrayFS.java Mon Dec 9 18:21:38 2013
@@ -29,7 +29,7 @@ public interface LongArrayFS extends Com
/**
* Get the i-th element from the array.
- *
+ * @param i the index
* @return The i-th element.
* @exception ArrayIndexOutOfBoundsException
* If the index is out of bounds.
@@ -61,8 +61,8 @@ public interface LongArrayFS extends Com
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, long[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ShortArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ShortArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ShortArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ShortArrayFS.java Mon Dec 9 18:21:38 2013
@@ -29,7 +29,7 @@ public interface ShortArrayFS extends Co
/**
* Get the i-th element from the array.
- *
+ * @param i the index
* @return The i-th element.
* @exception ArrayIndexOutOfBoundsException
* If the index is out of bounds.
@@ -61,8 +61,8 @@ public interface ShortArrayFS extends Co
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 0</code> or <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
void copyToArray(int srcOffset, short[] dest, int destOffset, int length)
throws ArrayIndexOutOfBoundsException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaFS.java Mon Dec 9 18:21:38 2013
@@ -33,7 +33,7 @@ import java.io.InputStream;
* data outside the CAS.
* </ul>
* <p>
- * SofaFS (the feature structure that represents a sofa) are created as a side effect of
+ * SofaFS (the feature structure that represents a SofA) are created as a side effect of
* creating a new CAS view. To create a new CAS view, use
* {@link org.apache.uima.cas.CAS#createView CAS.createView(string-view-name)}.
* From the returned CAS view, you can get the associated SofaFS instance, using
@@ -55,7 +55,7 @@ public interface SofaFS extends FeatureS
/**
* Set the URI for a Remote Subject of Analysis. Once set, this URI may not be changed.
- *
+ * @param aURI the URI for a remote Sofa
* @throws CASRuntimeException
* if the Sofa data has already been set
*/
@@ -64,7 +64,7 @@ public interface SofaFS extends FeatureS
/**
* Set the Local Subject of Analysis to be a predefined ArrayFS. Once set, the Sofa data cannot be
* changed.
- *
+ * @param aFS the SofA
* @throws CASRuntimeException
* if given FS is not an ArrayFS, or if the Sofa data has already been set
*/
@@ -72,7 +72,7 @@ public interface SofaFS extends FeatureS
/**
* Set the Local Subject of Analysis to be a String. Once set, the Sofa data cannot be changed.
- *
+ * @param aString The subject of analysis
* @throws CASRuntimeException
* if the Sofa data has already been set
*/
@@ -80,11 +80,13 @@ public interface SofaFS extends FeatureS
/**
* Get the Local Subject of Analysis returns null if not previously set.
+ * @return the local SofA
*/
FeatureStructure getLocalFSData();
/**
* Get the Local Subject of Analysis returns null if not previously set.
+ * @return the SofA
*/
String getLocalStringData();
@@ -111,13 +113,14 @@ public interface SofaFS extends FeatureS
/**
* Get the Sofa Ref value.
+ * @return the Sofa Reference value
*/
int getSofaRef();
/**
* Provides stream access to both local and remote Sofa data.
*
- * For remote sofa data, a custom URLStreamHandler may be registered for a protocol via the
+ * For remote SofA data, a custom URLStreamHandler may be registered for a protocol via the
* java.protocol.handler.pkgs system property.
*
* @return an InputStream for reading Sofa data. null returned if there is no Sofa data.
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/StringArrayFS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/StringArrayFS.java?rev=1549633&r1=1549632&r2=1549633&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/StringArrayFS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/StringArrayFS.java Mon Dec 9 18:21:38 2013
@@ -36,7 +36,7 @@ public interface StringArrayFS extends C
/**
* Get the i-th string from the array.
- *
+ * @param i the index
* @return The i-th element.
* @exception ArrayIndexOutOfBoundsException
* If the index is out of bounds.
@@ -68,8 +68,8 @@ public interface StringArrayFS extends C
* @param length
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
- * If <code>srcOffset < 0</code> or <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * If <code>srcOffset < 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;