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 2014/09/11 15:59:30 UTC
svn commit: r1624293 - in
/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima: cas/ cas/impl/
collection/ collection/base_cpm/ collection/metadata/ examples/ jcas/cas/
uimacpp/ util/
Author: schor
Date: Thu Sep 11 13:59:29 2014
New Revision: 1624293
URL: http://svn.apache.org/r1624293
Log:
no Jira, clean up next batch of Java 8 javadoc lint warnings
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/AbstractCas_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CASRuntimeException.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSMatchConstraint.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/Marker.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ParsingException.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaID.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelCAS.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasConsumer_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionReader_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataCollectionReader_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataConsumer_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataInitializer_ImplBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCasProcessor.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeDescription.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeLocalCasProcessor.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/OutputQueue.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppEngine.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppException.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/AbstractCas_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/AbstractCas_ImplBase.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/AbstractCas_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/AbstractCas_ImplBase.java Thu Sep 11 13:59:29 2014
@@ -41,7 +41,7 @@ public abstract class AbstractCas_ImplBa
* when a CAS instance is created. This handle is used to implement the release() method by
* returning the CAS to its CasOwner.
*
- * @param aCasOwner
+ * @param aCasOwner -
*/
public void setOwner(CasOwner aCasOwner) {
mOwner = aCasOwner;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java Thu Sep 11 13:59:29 2014
@@ -561,6 +561,7 @@ public interface CAS extends AbstractCas
* Get the JCas for this CAS.
*
* @return The JCas for this CAS.
+ * @throws CASException -
*/
JCas getJCas() throws CASException;
@@ -576,6 +577,7 @@ public interface CAS extends AbstractCas
/**
* Get sofaFS for given Subject of Analysis ID.
*
+ * @param sofaID -
* @return The sofaFS.
*
* @deprecated As of v2.0, use {#getView(String)}. From the view you can access the Sofa data, or
@@ -619,6 +621,7 @@ public interface CAS extends AbstractCas
* a Sofa feature structure in this CAS.
*
* @return The JCas view for the given Sofa.
+ * @throws CASException -
*/
JCas getJCas(SofaFS aSofa) throws CASException;
@@ -630,7 +633,7 @@ public interface CAS extends AbstractCas
* the ID of a Sofa defined in this CAS
*
* @return The view for the Sofa with ID <code>aSofaID</code>.
- * @throws CASRuntimeException
+ * @throws CASException
* if no Sofa with the given ID exists in this CAS
*
* @deprecated As of v2.0, use {@link #getView(String)} followed by {@link #getJCas()}.
@@ -768,6 +771,8 @@ public interface CAS extends AbstractCas
/**
* Create a Subject of Analysis. The new sofaFS is automatically added to the SofaIndex.
*
+ * @param sofaID -
+ * @param mimeType -
* @return The sofaFS.
*
* @deprecated As of v2.0, use {@link #createView(String)} instead.
@@ -790,6 +795,7 @@ public interface CAS extends AbstractCas
* The input iterator.
* @param cons
* The constraint specifying what structures should be returned.
+ * @param <T> - the type of the Feature Structure
* @return An iterator over FSs.
*/
<T extends FeatureStructure> FSIterator<T> createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons);
@@ -823,6 +829,7 @@ public interface CAS extends AbstractCas
*
* @param it
* The <code>FSListIterator</code> to be wrapped.
+ * @param <T> The type of FeatureStructure
* @return An equivalent <code>ListIterator</code>.
*/
<T extends FeatureStructure> ListIterator<T> fs2listIterator(FSIterator<T> it);
@@ -906,7 +913,7 @@ public interface CAS extends AbstractCas
* Sets the language for this document. This value sets the language feature of the special
* instance of DocumentAnnotation associated with this CAS.
*
- * @param languageCode
+ * @param languageCode -
* @throws CASRuntimeException passthru
*/
void setDocumentLanguage(String languageCode) throws CASRuntimeException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CASRuntimeException.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CASRuntimeException.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CASRuntimeException.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CASRuntimeException.java Thu Sep 11 13:59:29 2014
@@ -31,7 +31,7 @@ public class CASRuntimeException extends
/** Can''t create FS of type "{0}" with this method. */
public static final String NON_CREATABLE_TYPE = "NON_CREATABLE_TYPE";
- /** Array size must be >= 0. */
+ /** Array size must be >= 0. */
public static final String ILLEGAL_ARRAY_SIZE = "ILLEGAL_ARRAY_SIZE";
/** Expected value of type "{0}", but found "{1}". */
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSMatchConstraint.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSMatchConstraint.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSMatchConstraint.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSMatchConstraint.java Thu Sep 11 13:59:29 2014
@@ -43,6 +43,7 @@ public interface FSMatchConstraint exten
*
* @param fs
* The feature structure we want to match.
+ * @return -
*/
boolean match(FeatureStructure fs);
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=1624293&r1=1624292&r2=1624293&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 Thu Sep 11 13:59:29 2014
@@ -100,8 +100,8 @@ public interface FeatureValuePath {
* leaf snippet is <code>COVERED_TEXT</code>, returns the covered text of
* <code>currentFS</code>.
*
- * @param currentFS
- * @param cas
+ * @param currentFS -
+ * @param cas -
* @return A string representation of the leaf value.
*/
public String evaluateAsString(int currentFS, LowLevelCAS cas);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/Marker.java Thu Sep 11 13:59:29 2014
@@ -27,7 +27,7 @@ package org.apache.uima.cas;
public interface Marker {
/**
- * @param fs
+ * @param fs -
* @return true if a <code>FeatureStructure</code> was created after the mark represented by this <code>Marker</code> object.
*/
boolean isNew(FeatureStructure fs);
@@ -35,7 +35,7 @@ public interface Marker {
/**
* Test if a FeatureStructure in a CAS represented by this <code>Marker</code> existed before the mark was set, and has been modified.
* isModified(fs) == true implies that isNew(fs) == false.
- * @param fs
+ * @param fs -
* @return true if a <code>FeatureStructure</code> that existed prior to the mark being set has been modified
*/
boolean isModified(FeatureStructure fs);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ParsingException.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ParsingException.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ParsingException.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/ParsingException.java Thu Sep 11 13:59:29 2014
@@ -36,7 +36,7 @@ public class ParsingException extends Ex
}
/**
- * @param message
+ * @param message -
*/
public ParsingException(String message) {
super(message);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaID.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaID.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaID.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SofaID.java Thu Sep 11 13:59:29 2014
@@ -33,7 +33,7 @@ public interface SofaID {
/**
* Set the Sofa ID of a Sofa FS in the CAS.
*
- * @param aSofaID
+ * @param aSofaID -
*/
public void setSofaID(String aSofaID);
@@ -48,7 +48,7 @@ public interface SofaID {
* Set the component Sofa name that was used to obtain this SofaID by calling
* {@link org.apache.uima.UimaContext#mapToSofaID UimaContext.mapToSofaID()}.
*
- * @param aSofaName
+ * @param aSofaName -
*/
public void setComponentSofaName(String aSofaName);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelCAS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelCAS.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelCAS.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelCAS.java Thu Sep 11 13:59:29 2014
@@ -54,9 +54,8 @@ import org.apache.uima.cas.FeatureStruct
* checking on. We strongly encourage you to use those versions during development, they may save
* you a lot of time. One way you can use the type checking switch is by having a constant
*
- * <p>
- *
* <pre>
+ *
* static final boolean DO_TYPE_CHECK = true;
* </pre>
*
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasConsumer_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasConsumer_ImplBase.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasConsumer_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasConsumer_ImplBase.java Thu Sep 11 13:59:29 2014
@@ -52,7 +52,6 @@ public abstract class CasConsumer_ImplBa
* method; instead they should override the zero-argument {@link #initialize()} method and access
* metadata via the {@link #getProcessingResourceMetaData()} method. This method is non-final only
* for legacy reasons.
- * <p>
*
* @see org.apache.uima.resource.Resource#initialize(org.apache.uima.resource.ResourceSpecifier,
* java.util.Map)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer_ImplBase.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CasInitializer_ImplBase.java Thu Sep 11 13:59:29 2014
@@ -46,7 +46,6 @@ public abstract class CasInitializer_Imp
* method; instead they should override the zero-argument {@link #initialize()} method and access
* metadata via the {@link #getProcessingResourceMetaData()} method. This method is non-final only
* for legacy reasons.
- * <p>
*
* @see org.apache.uima.resource.Resource#initialize(org.apache.uima.resource.ResourceSpecifier,
* java.util.Map)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionReader_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionReader_ImplBase.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionReader_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/CollectionReader_ImplBase.java Thu Sep 11 13:59:29 2014
@@ -57,7 +57,6 @@ private CasInitializer mCasInitializer;
* override this method; instead they should override the zero-argument {@link #initialize()}
* method and access metadata via the {@link #getProcessingResourceMetaData()} method. This method
* is non-final only for legacy reasons.
- * <p>
*
* @see org.apache.uima.resource.Resource#initialize(org.apache.uima.resource.ResourceSpecifier,
* java.util.Map)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataCollectionReader_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataCollectionReader_ImplBase.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataCollectionReader_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataCollectionReader_ImplBase.java Thu Sep 11 13:59:29 2014
@@ -47,7 +47,6 @@ public abstract class CasDataCollectionR
* override this method; instead they should override the zero-argument {@link #initialize()}
* method and access metadata via the {@link #getProcessingResourceMetaData()} method. This method
* is non-final only for legacy reasons.
- * <p>
*
* @see org.apache.uima.resource.Resource#initialize(org.apache.uima.resource.ResourceSpecifier,
* java.util.Map)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataConsumer_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataConsumer_ImplBase.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataConsumer_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataConsumer_ImplBase.java Thu Sep 11 13:59:29 2014
@@ -39,7 +39,6 @@ public abstract class CasDataConsumer_Im
* method; instead they should override the zero-argument {@link #initialize()} method and access
* metadata via the {@link #getProcessingResourceMetaData()} method. This method is non-final only
* for legacy reasons.
- * <p>
*
* @see org.apache.uima.resource.Resource#initialize(org.apache.uima.resource.ResourceSpecifier,
* java.util.Map)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataInitializer_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataInitializer_ImplBase.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataInitializer_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/base_cpm/CasDataInitializer_ImplBase.java Thu Sep 11 13:59:29 2014
@@ -49,7 +49,6 @@ public abstract class CasDataInitializer
* method; instead they should override the zero-argument {@link #initialize()} method and access
* metadata via the {@link #getProcessingResourceMetaData()} method. This method is non-final only
* for legacy reasons.
- * <p>
*
* @see org.apache.uima.resource.Resource#initialize(org.apache.uima.resource.ResourceSpecifier,
* java.util.Map)
@@ -81,6 +80,7 @@ public abstract class CasDataInitializer
/**
* @see org.apache.uima.collection.base_cpm.CasProcessor#getProcessingResourceMetaData()
+ * @return -
*/
public ProcessingResourceMetaData getProcessingResourceMetaData() {
return (ProcessingResourceMetaData) getMetaData();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCasProcessor.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCasProcessor.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCasProcessor.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeCasProcessor.java Thu Sep 11 13:59:29 2014
@@ -335,7 +335,7 @@ public interface CpeCasProcessor extends
public CpeSofaMappings getSofaNameMappings();
/**
- * @param mappings
+ * @param mappings -
*/
public void setSofaNameMappings(CpeSofaMappings mappings);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeDescription.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeDescription.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeDescription.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeDescription.java Thu Sep 11 13:59:29 2014
@@ -34,9 +34,6 @@ import org.apache.uima.util.XMLInputSour
* {@link org.apache.uima.collection.impl.metadata.cpe.CpeDescriptorFactory#produceDescriptor()}. A
* CPE instance can then be created by calling
* {@link org.apache.uima.UIMAFramework#produceCollectionProcessingEngine(CpeDescription)}.
- * <p>
- *
- *
*/
public interface CpeDescription extends MetaDataObject {
@@ -91,7 +88,7 @@ public interface CpeDescription extends
/**
* Returns a {@link org.apache.uima.collection.metadata.CpeCasProcessors} instance containing
* processing pipeline spec. This includes:
- * <p>
+ *
* <ul>
* <li> the size of the InputQueue
* <li> the size of the OutputQueue
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeLocalCasProcessor.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeLocalCasProcessor.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeLocalCasProcessor.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeLocalCasProcessor.java Thu Sep 11 13:59:29 2014
@@ -34,6 +34,7 @@ public interface CpeLocalCasProcessor ex
* Returns true if the local Cas Processor is a java program
*
* @return true if java program, false otherwise
+ * @throws CpeDescriptorException -
*/
public boolean isJava() throws CpeDescriptorException;
@@ -42,6 +43,7 @@ public interface CpeLocalCasProcessor ex
*
* @param aJava -
* true if java, false otherwise
+ * @throws CpeDescriptorException -
*/
public void setIsJava(boolean aJava) throws CpeDescriptorException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/CpeSofaMapping.java Thu Sep 11 13:59:29 2014
@@ -30,12 +30,12 @@ public interface CpeSofaMapping extends
public String getCpeSofaName();
/**
- * @param string
+ * @param string -
*/
public void setComponentSofaName(String string);
/**
- * @param string
+ * @param string -
*/
public void setCpeSofaName(String string);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/OutputQueue.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/OutputQueue.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/OutputQueue.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/collection/metadata/OutputQueue.java Thu Sep 11 13:59:29 2014
@@ -44,7 +44,7 @@ public interface OutputQueue extends Met
/**
* Define the time (in ms) to wait for a new message
*
- * @param i
+ * @param i the time (in ms) to wait for a new message
*/
public void setDequeueTimeout(int i);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java Thu Sep 11 13:59:29 2014
@@ -63,6 +63,8 @@ public class SourceDocumentInformation e
/**
* Internal - constructor used by generator
*
+ * @param addr -
+ * @param type -
* @generated
*/
public SourceDocumentInformation(int addr, TOP_Type type) {
@@ -70,13 +72,21 @@ public class SourceDocumentInformation e
readObject();
}
- /** @generated */
+ /**
+ * @generated
+ * @param jcas -
+ * */
public SourceDocumentInformation(JCas jcas) {
super(jcas);
readObject();
}
- /** @generated */
+ /**
+ * @generated
+ * @param jcas -
+ * @param begin -
+ * @param end -
+ * */
public SourceDocumentInformation(JCas jcas, int begin, int end) {
super(jcas);
setBegin(begin);
@@ -100,6 +110,7 @@ public class SourceDocumentInformation e
* simple file or http://incubator.apache.org/uima/index.html for content from a web source.)
*
* @generated
+ * @return the Uri
*/
public String getUri() {
if (SourceDocumentInformation_Type.featOkTst
@@ -113,6 +124,7 @@ public class SourceDocumentInformation e
* setter for uri - sets URI of document. (For example, file:///MyDirectory/myFile.txt for a
* simple file or http://incubator.apache.org/uima/index.html for content from a web source.)
*
+ * @param v this document's Uri
* @generated
*/
public void setUri(String v) {
@@ -131,6 +143,7 @@ public class SourceDocumentInformation e
* source file or other input source. Only used if the CAS document was retrieved from an source
* where one physical source file contained several conceptual documents. Zero otherwise.
*
+ * @return the byte offset of the start of the document within the original
* @generated
*/
public int getOffsetInSource() {
@@ -146,6 +159,7 @@ public class SourceDocumentInformation e
* source file or other input source. Only used if the CAS document was retrieved from an source
* where one physical source file contained several conceptual documents. Zero otherwise.
*
+ * @param v the byte offset of the start of the document within the original
* @generated
*/
public void setOffsetInSource(int v) {
@@ -163,6 +177,7 @@ public class SourceDocumentInformation e
* getter for documentSize - gets Size of original document in bytes before processing by CAS
* Initializer. Either absolute file size of size within file or other source.
*
+ * @return the document size in bytes
* @generated
*/
public int getDocumentSize() {
@@ -177,6 +192,7 @@ public class SourceDocumentInformation e
* setter for documentSize - sets Size of original document in bytes before processing by CAS
* Initializer. Either absolute file size of size within file or other source.
*
+ * @param v the document size in bytes
* @generated
*/
public void setDocumentSize(int v) {
@@ -196,6 +212,7 @@ public class SourceDocumentInformation e
* useful for downstream components that want to take some action after having seen all of the
* segments of a particular source document.
*
+ * @return true if this is the final segment
* @generated
*/
public boolean getLastSegment() {
@@ -212,6 +229,7 @@ public class SourceDocumentInformation e
* useful for downstream components that want to take some action after having seen all of the
* segments of a particular source document.
*
+ * @param v true if this is the last segment
* @generated
*/
public void setLastSegment(boolean v) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation_Type.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation_Type.java Thu Sep 11 13:59:29 2014
@@ -77,14 +77,22 @@ public class SourceDocumentInformation_T
/** @generated */
final int casFeatCode_uri;
- /** @generated */
+ /**
+ * @param addr -
+ * @return the Uri
+ * @generated
+ * */
public String getUri(int addr) {
if (featOkTst && casFeat_uri == null)
this.jcas.throwFeatMissing("uri", "org.apache.uima.examples.SourceDocumentInformation");
return ll_cas.ll_getStringValue(addr, casFeatCode_uri);
}
- /** @generated */
+ /**
+ * @param addr -
+ * @param v the Uri
+ * @generated
+ * */
public void setUri(int addr, String v) {
if (featOkTst && casFeat_uri == null)
this.jcas.throwFeatMissing("uri", "org.apache.uima.examples.SourceDocumentInformation");
@@ -97,14 +105,22 @@ public class SourceDocumentInformation_T
/** @generated */
final int casFeatCode_offsetInSource;
- /** @generated */
+ /**
+ * @param addr -
+ * @return -
+ * @generated
+ * */
public int getOffsetInSource(int addr) {
if (featOkTst && casFeat_offsetInSource == null)
this.jcas.throwFeatMissing("offsetInSource", "org.apache.uima.examples.SourceDocumentInformation");
return ll_cas.ll_getIntValue(addr, casFeatCode_offsetInSource);
}
- /** @generated */
+ /**
+ * @param addr -
+ * @param v -
+ * @generated
+ * */
public void setOffsetInSource(int addr, int v) {
if (featOkTst && casFeat_offsetInSource == null)
this.jcas.throwFeatMissing("offsetInSource", "org.apache.uima.examples.SourceDocumentInformation");
@@ -117,34 +133,52 @@ public class SourceDocumentInformation_T
/** @generated */
final int casFeatCode_documentSize;
- /** @generated */
+ /**
+ * @param addr -
+ * @return -
+ * @generated
+ * */
public int getDocumentSize(int addr) {
if (featOkTst && casFeat_documentSize == null)
this.jcas.throwFeatMissing("documentSize", "org.apache.uima.examples.SourceDocumentInformation");
return ll_cas.ll_getIntValue(addr, casFeatCode_documentSize);
}
- /** @generated */
+ /**
+ * @param addr -
+ * @param v the document size
+ * @generated
+ * */
public void setDocumentSize(int addr, int v) {
if (featOkTst && casFeat_documentSize == null)
this.jcas.throwFeatMissing("documentSize", "org.apache.uima.examples.SourceDocumentInformation");
ll_cas.ll_setIntValue(addr, casFeatCode_documentSize, v);
}
- /** @generated */
+ /**
+ * @generated
+ * */
final Feature casFeat_lastSegment;
/** @generated */
final int casFeatCode_lastSegment;
- /** @generated */
+ /**
+ * @param addr -
+ * @return true if it is last segment
+ * @generated
+ * */
public boolean getLastSegment(int addr) {
if (featOkTst && casFeat_lastSegment == null)
this.jcas.throwFeatMissing("lastSegment", "org.apache.uima.examples.SourceDocumentInformation");
return ll_cas.ll_getBooleanValue(addr, casFeatCode_lastSegment);
}
- /** @generated */
+ /**
+ * @param addr -
+ * @param v true if last segment
+ * @generated
+ * */
public void setLastSegment(int addr, boolean v) {
if (featOkTst && casFeat_lastSegment == null)
this.jcas.throwFeatMissing("lastSegment", "org.apache.uima.examples.SourceDocumentInformation");
@@ -154,6 +188,8 @@ public class SourceDocumentInformation_T
/**
* initialize variables to correspond with Cas Type and Features
*
+ * @param jcas -
+ * @param casType -
* @generated
*/
public SourceDocumentInformation_Type(JCas jcas, Type casType) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java Thu Sep 11 13:59:29 2014
@@ -66,6 +66,8 @@ public class Sofa extends TOP implements
* Internal - constructor used by generator
*
* @generated
+ * @param addr the address
+ * @param type the type
*/
public Sofa(int addr, TOP_Type type) {
super(addr, type);
@@ -106,6 +108,7 @@ public class Sofa extends TOP implements
* getter for sofaNum - gets
*
* @generated
+ * @return the sofa number
*/
public int getSofaNum() {
if (Sofa_Type.featOkTst && ((Sofa_Type) jcasType).casFeat_sofaNum == null)
@@ -134,6 +137,7 @@ public class Sofa extends TOP implements
* getter for mimeType - gets
*
* @generated
+ * @return the mime type
*/
public String getMimeType() {
if (Sofa_Type.featOkTst && ((Sofa_Type) jcasType).casFeat_mimeType == null)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java Thu Sep 11 13:59:29 2014
@@ -87,6 +87,8 @@ public class Sofa_Type extends TOP_Type
/**
* initialize variables to correspond with Cas Type and Features
*
+ * @param jcas the JCas
+ * @param casType the Sofa Type Instance
* @generated
*/
public Sofa_Type(JCas jcas, Type casType) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppAnalysisComponent.java Thu Sep 11 13:59:29 2014
@@ -174,6 +174,7 @@ public class UimacppAnalysisComponent ex
* @see org.apache.uima.analysis_component.CasAnnotator_ImplBase#typeSystemInit(TypeSystem)
* @param ts TypeSystem to use in the initialization
* @throws AnnotatorConfigurationException pass thru
+ * @throws AnnotatorInitializationException pass thru
*/
public void typeSystemInit(TypeSystem ts) throws AnnotatorConfigurationException,
AnnotatorInitializationException {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppEngine.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppEngine.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppEngine.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppEngine.java Thu Sep 11 13:59:29 2014
@@ -224,6 +224,7 @@ public class UimacppEngine {
/**
* create a TAF engine with a config file
* @param configFile the configuration file used for initialization
+ * @return a UimacppEngine
* @throws UimacppException pass thru
*/
public static UimacppEngine createJTafTAE(String configFile) throws UimacppException {
@@ -490,6 +491,7 @@ public class UimacppEngine {
/**
* helper function to get the TAF JNI version.
+ * @return Taf JNI Version
* @throws UimacppException wraps any exception
*/
public static String getTafJNIVersion() throws UimacppException {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppException.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppException.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppException.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/uimacpp/UimacppException.java Thu Sep 11 13:59:29 2014
@@ -99,6 +99,7 @@ public class UimacppException extends Ex
/**
* get the embedded exception, if any.
+ * @return the embedded exception
*/
public Exception getEmbeddedException() {
return detail;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java?rev=1624293&r1=1624292&r2=1624293&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasToInlineXml.java Thu Sep 11 13:59:29 2014
@@ -82,6 +82,7 @@ public class CasToInlineXml {
* Formats a CAS as a String.
* @param aCAS the cas to format as an xml string
* @return the XML representation of the CAS
+ * @throws CASException -
*/
public String format(CAS aCAS) throws CASException {
return generateXML(aCAS, null);
@@ -104,6 +105,7 @@ public class CasToInlineXml {
* @param aCAS
* CAS to generate from
* @return the inline XML version of the CAS
+ * @throws CASException -
*/
public String generateXML(CAS aCAS) throws CASException {
return generateXML(aCAS, null);
@@ -118,7 +120,7 @@ public class CasToInlineXml {
* constraint that determines which annotations are included in the output. If null (or
* omitted), all annotations are included.
* @param aHandler the content handler to use
- * @throws CASException
+ * @throws CASException -
*/
public void generateXML(CAS aCAS, FSMatchConstraint aFilter, ContentHandler aHandler) throws CASException {
@@ -246,6 +248,7 @@ public class CasToInlineXml {
* @param aFilter
* constraint that determines which annotations are included in the output. If null (or
* ommitted), all annotations are included.
+ * @throws CASException -
* @return the inline form
*/
public String generateXML(CAS aCAS, FSMatchConstraint aFilter) throws CASException {