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/01/06 21:15:48 UTC
svn commit: r1556016 [2/3] - in /uima/uimaj/trunk/uimaj-core/src:
main/java/org/apache/uima/ main/java/org/apache/uima/analysis_engine/
main/java/org/apache/uima/analysis_engine/asb/
main/java/org/apache/uima/analysis_engine/asb/impl/ main/java/org/apa...
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=1556016&r1=1556015&r2=1556016&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 Mon Jan 6 20:15:45 2014
@@ -60,7 +60,7 @@ public class SourceDocumentInformation e
protected SourceDocumentInformation() {
}
- /*
+ /**
* Internal - constructor used by generator
*
* @generated
@@ -95,7 +95,7 @@ public class SourceDocumentInformation e
// *--------------*
// * Feature: uri
- /*
+ /**
* getter for uri - gets 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.)
*
@@ -109,7 +109,7 @@ public class SourceDocumentInformation e
((SourceDocumentInformation_Type) jcasType).casFeatCode_uri);
}
- /*
+ /**
* 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.)
*
@@ -126,7 +126,7 @@ public class SourceDocumentInformation e
// *--------------*
// * Feature: offsetInSource
- /*
+ /**
* getter for offsetInSource - gets Byte offset of the start of document content within original
* 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.
@@ -141,7 +141,7 @@ public class SourceDocumentInformation e
((SourceDocumentInformation_Type) jcasType).casFeatCode_offsetInSource);
}
- /*
+ /**
* setter for offsetInSource - sets Byte offset of the start of document content within original
* 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.
@@ -159,7 +159,7 @@ public class SourceDocumentInformation e
// *--------------*
// * Feature: documentSize
- /*
+ /**
* 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.
*
@@ -173,7 +173,7 @@ public class SourceDocumentInformation e
((SourceDocumentInformation_Type) jcasType).casFeatCode_documentSize);
}
- /*
+ /**
* 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.
*
@@ -190,7 +190,7 @@ public class SourceDocumentInformation e
// *--------------*
// * Feature: lastSegment
- /*
+ /**
* getter for lastSegment - gets For a CAS that represents a segment of a larger source document,
* this flag indicates whether this CAS is the final segment of the source document. This is
* useful for downstream components that want to take some action after having seen all of the
@@ -206,7 +206,7 @@ public class SourceDocumentInformation e
((SourceDocumentInformation_Type) jcasType).casFeatCode_lastSegment);
}
- /*
+ /**
* setter for lastSegment - sets For a CAS that represents a segment of a larger source document,
* this flag indicates whether this CAS is the final segment of the source document. This is
* useful for downstream components that want to take some action after having seen all of the
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/CasFlowController_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/CasFlowController_ImplBase.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/CasFlowController_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/CasFlowController_ImplBase.java Mon Jan 6 20:15:45 2014
@@ -91,7 +91,7 @@ public abstract class CasFlowController_
* @param aTypeSystem
* the typesystem
*
- * @throws CasProcessorComponentException
+ * @throws AnalysisEngineProcessException
* if a problem occurs during processing
*/
public void typeSystemInit(TypeSystem aTypeSystem) throws AnalysisEngineProcessException {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/CasFlow_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/CasFlow_ImplBase.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/CasFlow_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/CasFlow_ImplBase.java Mon Jan 6 20:15:45 2014
@@ -93,10 +93,10 @@ public abstract class CasFlow_ImplBase i
* the key of the CAS Multiplier that produced this CAS
*
* @return a Flow object that will be used to route the new CAS
+ * @throws AnalysisEngineProcessException passthru
* @see Flow#newCasProduced(AbstractCas, String)
*/
- protected Flow newCasProduced(CAS newCas, String producedBy)
- throws AnalysisEngineProcessException {
+ protected Flow newCasProduced(CAS newCas, String producedBy) throws AnalysisEngineProcessException {
throw new UIMA_UnsupportedOperationException(
UIMA_UnsupportedOperationException.CAS_MULTIPLIER_NOT_SUPPORTED, new Object[] { this
.getClass().getName() });
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/Flow.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/Flow.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/Flow.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/Flow.java Mon Jan 6 20:15:45 2014
@@ -58,7 +58,7 @@ public interface Flow {
* @return a new Flow object that has responsibility for routing <code>aCAS</code> through the
* Aggregate Analysis Engine.
*
- * @throws AnalysisEngineProcessException
+ * @throws AnalysisEngineProcessException passthru
*/
Flow newCasProduced(AbstractCas newCas, String producedBy) throws AnalysisEngineProcessException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/FlowController.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/FlowController.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/FlowController.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/FlowController.java Mon Jan 6 20:15:45 2014
@@ -85,7 +85,7 @@ public interface FlowController {
* calling <code>destroy</code> followed by <code>initialize</code>. If a more efficient
* implementation is needed, you can override that implementation.
*
- * @throws ResourceConfiguartionException
+ * @throws ResourceConfigurationException
* if the new configuration is invalid
* @throws ResourceInitializationException
* if this component encounters a problem in reinitializing itself from the new
@@ -142,7 +142,7 @@ public interface FlowController {
* @return a Flow object that has responsibility for routing <code>aCAS</code> through the
* Aggregate Analysis Engine.
*
- * @throws AnalysisEngineComponentException
+ * @throws AnalysisEngineProcessException
* if this FlowController encounters a problem computing the flow for the CAS
*/
Flow computeFlow(AbstractCas aCAS) throws AnalysisEngineProcessException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/JCasFlow_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/JCasFlow_ImplBase.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/JCasFlow_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/JCasFlow_ImplBase.java Mon Jan 6 20:15:45 2014
@@ -91,7 +91,9 @@ public abstract class JCasFlow_ImplBase
* the key of the CAS Multiplier that produced this JCas
*
* @return a Flow object that will be used to route the new JCas
+ * @throws AnalysisEngineProcessException -
* @see Flow#newCasProduced(AbstractCas, String)
+ *
*/
protected Flow newCasProduced(JCas newCas, String producedBy)
throws AnalysisEngineProcessException {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStepWithResultSpec.java Mon Jan 6 20:15:45 2014
@@ -33,8 +33,8 @@ import org.apache.uima.analysis_engine.R
public class SimpleStepWithResultSpec extends SimpleStep {
/**
- * @param aCasProcessorKey
- * @param aResultSpec
+ * @param aCasProcessorKey key
+ * @param aResultSpec Result Specification
*/
public SimpleStepWithResultSpec(String aCasProcessorKey, ResultSpecification aResultSpec) {
super(aCasProcessorKey);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/impl/UimaContext_ImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/impl/UimaContext_ImplBase.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/impl/UimaContext_ImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/impl/UimaContext_ImplBase.java Mon Jan 6 20:15:45 2014
@@ -58,9 +58,7 @@ import org.apache.uima.util.Level;
import org.apache.uima.util.Settings;
import org.apache.uima.util.UriUtils;
-/**
- *
- */
+
public abstract class UimaContext_ImplBase implements UimaContextAdmin {
/**
* resource bundle for log messages
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArraySpanMap.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArraySpanMap.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArraySpanMap.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArraySpanMap.java Mon Jan 6 20:15:45 2014
@@ -191,9 +191,9 @@ public class CharArraySpanMap {
* Length of sub-range.
* @return <code>true</code> iff the map contains the key.
* @pre characterArray != null
- * @pre start >= 0
- * @pre length >= 0
- * @pre length <= (characterArray.length - start)
+ * @pre start ≥ 0
+ * @pre length ≥ 0
+ * @pre length ≤ (characterArray.length - start)
*/
public final boolean containsKey(char[] characterArray, int start, int length) {
final int hashCode = CharArrayString.hashCode(characterArray, start, (start + length));
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/CharArrayString.java Mon Jan 6 20:15:45 2014
@@ -79,10 +79,10 @@ public class CharArrayString {
* @param length
* The length of the string.
* @pre charArray != null
- * @pre startPos >= 0
- * @pre startPos <= charArray.length
- * @pre length >= 0
- * @pre length <= charArray.length - startPos
+ * @pre startPos ≥ 0
+ * @pre startPos ≤ charArray.length
+ * @pre length ≥ 0
+ * @pre length ≤ charArray.length - startPos
*/
public CharArrayString(char[] charArray, int startPos, int length) {
super();
@@ -349,9 +349,9 @@ public class CharArrayString {
* @param endPos
* @return The hash code.
* @pre charArray != null
- * @pre startPos >= 0
- * @pre endPos >= startPos
- * @pre charArray.length >= endPos
+ * @pre startPos ≥ 0
+ * @pre endPos ≥ startPos
+ * @pre charArray.length ≥ endPos
*/
public static final int hashCode(char[] charArray, int startPos, int endPos) {
// Universal hashing (pseudo-random), out of Sedgewick.
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/JavaTimer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/JavaTimer.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/JavaTimer.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/JavaTimer.java Mon Jan 6 20:15:45 2014
@@ -27,9 +27,7 @@ import org.apache.uima.util.UimaTimer;
*
*/
public class JavaTimer implements UimaTimer {
- /**
- *
- */
+
private static final long serialVersionUID = 4644107369628471363L;
private long start = 0;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/MutableInteger.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/MutableInteger.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/MutableInteger.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/MutableInteger.java Mon Jan 6 20:15:45 2014
@@ -19,9 +19,7 @@
package org.apache.uima.internal.util;
-/**
- *
- */
+
public class MutableInteger {
public int intValue;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/Int2IntRBT.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/Int2IntRBT.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/Int2IntRBT.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/Int2IntRBT.java Mon Jan 6 20:15:45 2014
@@ -397,9 +397,7 @@ public class Int2IntRBT extends IntArray
}
- /**
- *
- */
+
private int findKeyFromLast(final int k) {
int node = lastNodeGotten;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntArrayRBT.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntArrayRBT.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntArrayRBT.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntArrayRBT.java Mon Jan 6 20:15:45 2014
@@ -470,7 +470,9 @@ public class IntArrayRBT extends IntArra
}
/**
- * Find the node such that key[node] >= k and key[previous(node)] < k.
+ * Find the node such that key[node] ≥ k and key[previous(node)] < k.
+ * @param k the key
+ * @return the index of the node
*/
public int findInsertionPoint(final int k) {
int node = this.root;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntArrayRBTcommon.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntArrayRBTcommon.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntArrayRBTcommon.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntArrayRBTcommon.java Mon Jan 6 20:15:45 2014
@@ -473,7 +473,7 @@ public class IntArrayRBTcommon {
}
/**
- * Find the node such that key[node] >= k and key[previous(node)] < k.
+ * Find the node such that key[node] ≥ k and key[previous(node)] < k.
*/
public int findInsertionPointNoDups(final int k) {
int node = this.root;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntRedBlackTree.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntRedBlackTree.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntRedBlackTree.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/rb_trees/IntRedBlackTree.java Mon Jan 6 20:15:45 2014
@@ -200,7 +200,7 @@ public class IntRedBlackTree {
* {@link org.apache.uima.internal.util.rb_trees.IntRBTArray IntRBTArray} object.
*
* @param offset
- * An offset for internal addressing. If <code>offset > 0</code>, the addresses
+ * An offset for internal addressing. If <code>offset > 0</code>, the addresses
* generated for right daughters in two-daughter nodes are shifted to the right. This is
* useful if the resulting array will be copied to a certain <code>offset</code>
* position in a different array.
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java Mon Jan 6 20:15:45 2014
@@ -79,18 +79,22 @@ public interface JCas extends AbstractCa
// *********************************
// * Getters for read-only objects *
// *********************************
- /** return the FSIndexRepository object for this Cas. */
+ /**
+ * @return the FSIndexRepository object for this Cas
+ */
public abstract FSIndexRepository getFSIndexRepository();
public abstract LowLevelIndexRepository getLowLevelIndexRepository();
- /** return the Cas object for this JCas instantiation */
+ /**
+ * @return the CAS object for this JCas instantiation
+ */
public abstract CAS getCas();
- /** internal use */
+ /* internal use */
public abstract CASImpl getCasImpl();
- /** internal use */
+ /* internal use */
public abstract LowLevelCAS getLowLevelCas();
/**
@@ -115,48 +119,48 @@ public interface JCas extends AbstractCa
/**
* get the JCas x_Type instance for a particular Java instance of a type
*
- * @param instance
+ * @param instance instance
* @return the associated xxx_Type instance
* @deprecated use instance.jcasType instead - faster
*/
@Deprecated
public abstract TOP_Type getType(TOP instance);
- /**
+ /*
* Internal use - looks up a type-name-string in the CAS type system and returns the Cas Type
* object. Throws CASException if the type isn't found
*/
public abstract Type getRequiredType(String s) throws CASException;
- /**
+ /*
* Internal use - look up a feature-name-string in the CAS type system and returns the Cas Feature
* object. Throws CASException if the feature isn't found
*/
public abstract Feature getRequiredFeature(Type t, String s) throws CASException;
- /**
+ /*
* Internal Use - look up a feature-name-string in the CAS type system and returns the Cas Feature
* object. If the feature isn't found, adds an exception to the errorSet but doesn't throw
*/
public abstract Feature getRequiredFeatureDE(Type t, String s, String rangeName, boolean featOkTst);
- /**
+ /*
* Internal Use - sets the corresponding Java instance for a Cas instance
*/
public abstract void putJfsFromCaddr(int casAddr, FeatureStructure fs);
- /**
+ /*
* Internal Use - sets the corresponding Java instance for a Cas instance
*/
public abstract TOP getJfsFromCaddr(int casAddr);
- /**
+ /*
* Internal Use.
*/
public abstract void checkArrayBounds(int fsRef, int pos);
- /**
+ /*
* Internal Use - throw missing feature exception at runtime.
*/
public void throwFeatMissing(String feat, String type);
@@ -164,6 +168,8 @@ public interface JCas extends AbstractCa
/**
* @deprecated As of v2.0, use {#getView(String)}. From the view you can access the Sofa data, or
* call {@link #getSofa()} if you truly need to access the SofaFS object.
+ * @param sofaID -
+ * @return the Sofa
*/
@Deprecated
public abstract Sofa getSofa(SofaID sofaID);
@@ -190,7 +196,7 @@ public interface JCas extends AbstractCa
* same as the associated Sofa name).
*
* @return The view corresponding to this local name.
- * @throws CASRuntimeException
+ * @throws CASException -
* if a View with this name already exists in this CAS
*/
public abstract JCas createView(String sofaID) throws CASException;
@@ -202,6 +208,7 @@ public interface JCas extends AbstractCa
* a Sofa feature structure in this CAS.
*
* @return The JCas view for the given Sofa.
+ * @throws CASException -
*/
public abstract JCas getJCas(Sofa sofa) throws CASException;
@@ -233,6 +240,7 @@ public interface JCas extends AbstractCa
* avoid creating multiple copies of it. All uses can use the same valuee because it is not
* updatable (it has no subfields). This is initialized lazily on first reference, and reset when
* the CAS is reset.
+ * @return 0-length instance of a StringArray
*/
public abstract StringArray getStringArray0L();
@@ -242,6 +250,7 @@ public interface JCas extends AbstractCa
* avoid creating multiple copies of it. All uses can use the same valuee because it is not
* updatable (it has no subfields). This is initialized lazily on first reference, and reset when
* the CAS is reset.
+ * @return 0-length instance of an IntegerArray
*/
public abstract IntegerArray getIntegerArray0L();
@@ -250,7 +259,7 @@ public interface JCas extends AbstractCa
* avoid creating multiple copies of it. All uses can use the same valuee because it is not
* updatable (it has no subfields). This is initialized lazily on first reference, and reset when
* the CAS is reset.
- */
+ * @return 0-length instance of a FloatArray
public abstract FloatArray getFloatArray0L();
/**
@@ -258,6 +267,7 @@ public interface JCas extends AbstractCa
* avoid creating multiple copies of it. All uses can use the same valuee because it is not
* updatable (it has no subfields). This is initialized lazily on first reference, and reset when
* the CAS is reset.
+ * @return 0-length instance of a FSArray
*/
public abstract FSArray getFSArray0L();
@@ -279,7 +289,7 @@ public interface JCas extends AbstractCa
* same as the associated Sofa name).
*
* @return The view corresponding to this local name.
- * @throws CASException
+ * @throws CASException passthru
*
*/
JCas getView(String localViewName) throws CASException;
@@ -293,6 +303,7 @@ public interface JCas extends AbstractCa
* a Sofa feature structure in the CAS
*
* @return The view for the given Sofa
+ * @throws CASException passthru
*/
JCas getView(SofaFS aSofa) throws CASException;
@@ -319,7 +330,8 @@ public interface JCas extends AbstractCa
/**
* Create a Subject of Analysis. The new sofaFS is automatically added to the SofaIndex.
- *
+ * @param sofaID the SofA ID
+ * @param mimeType the mime type
* @return The sofaFS.
*
* @deprecated As of v2.0, use {@link #createView(String)} instead.
@@ -342,6 +354,7 @@ public interface JCas extends AbstractCa
* The input iterator.
* @param cons
* The constraint specifying what structures should be returned.
+ * @param <T> the particular FeatureStructure type
* @return An iterator over FSs.
*/
<T extends FeatureStructure> FSIterator<T> createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons);
@@ -375,6 +388,7 @@ public interface JCas extends AbstractCa
*
* @param it
* The <code>FSListIterator</code> to be wrapped.
+ * @param <T> The particular Feature Structure type
* @return An equivalent <code>ListIterator</code>.
*/
<T extends FeatureStructure> ListIterator<T> fs2listIterator(FSIterator<T> it);
@@ -458,8 +472,8 @@ public interface JCas extends AbstractCa
* Sets the language for this document. This value sets the language feature of the special
* instance of DocumentAnnotation associated with this CAS.
*
- * @param languageCode
- * @throws CASRuntimeException
+ * @param languageCode the language code
+ * @throws CASRuntimeException passthru
*/
void setDocumentLanguage(String languageCode) throws CASRuntimeException;
@@ -589,6 +603,7 @@ public interface JCas extends AbstractCa
* passed as an integer using the form
* MyAnnotationType.type
* @return The standard annotation index, restricted to <code>type</code>.
+ * @throws CASRuntimeException -
*/
AnnotationIndex<Annotation> getAnnotationIndex(int type) throws CASRuntimeException;
@@ -599,7 +614,8 @@ public interface JCas extends AbstractCa
*
* @return an iterator which returns all views. Each object returned by
* the iterator is of type JCas.
- */
+ * @throws CASException -
+ */
Iterator<JCas> getViewIterator() throws CASException;
/**
@@ -616,6 +632,7 @@ public interface JCas extends AbstractCa
*
* @return an iterator which returns all views with the given name prefix.
* Each object returned by the iterator is of type JCas.
+ * @throws CASException -
*/
Iterator<JCas> getViewIterator(String localViewNamePrefix) throws CASException;
}
\ No newline at end of file
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCasRegistry.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCasRegistry.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCasRegistry.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCasRegistry.java Mon Jan 6 20:15:45 2014
@@ -32,7 +32,7 @@ public class JCasRegistry {
* Registers a JCas cover class with this registry. The registry will assign
* it a unique index, which is then used by the cover-class to identify itself
* to the JCas implementation.
- *
+ * @param aJCasCoverClass the class to register
* @return the unique index value for this class.
*/
public static synchronized int register(Class aJCasCoverClass) {
@@ -47,6 +47,11 @@ public class JCasRegistry {
* this allows the runtime to skip this test.
* <p>
* This is reserved for future use; it currently always returns true.
+ * @param fullyQualTypeName fully qualified type name
+ * @return true if that type should have run-time checking for use of fields
+ * defined in the JCas Model which are not present in the CAS. If false, all fields
+ * in the JCas must be in the CAS type system at instantiation time, or an exception is thrown;
+ * this allows the runtime to skip this test.
*/
public static boolean getFeatOkTst(String fullyQualTypeName) {
return true;
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=1556016&r1=1556015&r2=1556016&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 Mon Jan 6 20:15:45 2014
@@ -62,7 +62,7 @@ public class Sofa extends TOP implements
protected Sofa() {
}
- /*
+ /**
* Internal - constructor used by generator
*
* @generated
@@ -102,7 +102,7 @@ public class Sofa extends TOP implements
// *--------------*
// * Feature: sofaNum
// ** Note: this gets the same feature, sofaNum, as getSofaRef, below
- /*
+ /**
* getter for sofaNum - gets
*
* @generated
@@ -116,7 +116,7 @@ public class Sofa extends TOP implements
// *--------------*
// * Feature: sofaID
- /*
+ /**
* getter for sofaID - gets
*
* @generated
@@ -130,7 +130,7 @@ public class Sofa extends TOP implements
// *--------------*
// * Feature: mimeType
- /*
+ /**
* getter for mimeType - gets
*
* @generated
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=1556016&r1=1556015&r2=1556016&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 Mon Jan 6 20:15:45 2014
@@ -84,7 +84,7 @@ public class Sofa_Type extends TOP_Type
/** @generated */
final int casFeatCode_mimeType;
- /*
+ /**
* initialize variables to correspond with Cas Type and Features
*
* @generated
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/impl/JCasImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/impl/JCasImpl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/impl/JCasImpl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/impl/JCasImpl.java Mon Jan 6 20:15:45 2014
@@ -508,7 +508,7 @@ public class JCasImpl extends AbstractCa
*
* @param cl
* class loader to switch to
- * @throws CASException
+ * @throws CASException passthru
*/
public void switchClassLoader(ClassLoader cl) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/tcas/Annotation.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/tcas/Annotation.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/tcas/Annotation.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/tcas/Annotation.java Mon Jan 6 20:15:45 2014
@@ -99,6 +99,9 @@ public class Annotation extends Annotati
/**
* Constructor with begin and end passed as arguments
+ * @param jcas JCas
+ * @param begin begin offset
+ * @param end end offset
*/
public Annotation(JCas jcas, int begin, int end) {
this(jcas); // forward to constructor
@@ -121,6 +124,8 @@ public class Annotation extends Annotati
/**
* @deprecated
+ * @see Annotation#getBegin()
+ * @return the Annotation "begin" feature value
*/
@Deprecated
public int getStart() {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/tcas/Annotation_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/tcas/Annotation_Type.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/tcas/Annotation_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/tcas/Annotation_Type.java Mon Jan 6 20:15:45 2014
@@ -88,6 +88,8 @@ public class Annotation_Type extends org
/**
* @see org.apache.uima.cas.text.AnnotationFS#getCoveredText()
+ * @param inst low level reference to a Feature Structure
+ * @return null or the covered text
*/
public String getCoveredText(int inst) {
final CASImpl casView = ll_cas.ll_getSofaCasView(inst);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/tools/InstallationTester.java Mon Jan 6 20:15:45 2014
@@ -140,7 +140,7 @@ public class InstallationTester {
*
* @return a ResourceManager object with the information from the PackageBrowser object.
*
- * @throws IOException
+ * @throws IOException passthru
*/
private static ResourceManager getResourceManager(PackageBrowser pkgBrowser) throws IOException {
ResourceManager resourceMgr = UIMAFramework.newDefaultResourceManager();
@@ -163,7 +163,7 @@ public class InstallationTester {
* @param pkgBrowser
* packageBrowser object of an installed PEAR package
*
- * @throws IOException
+ * @throws IOException passthru
*/
private static void setSystemProperties(PackageBrowser pkgBrowser) throws IOException {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/util/StringUtil.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/util/StringUtil.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/util/StringUtil.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/util/StringUtil.java Mon Jan 6 20:15:45 2014
@@ -192,8 +192,8 @@ public class StringUtil {
/**
* Converts a given input string to another string that can be used as a 'replacement' string in
- * the <code>String::replaceAll(String regex, String replacement)</code> method. <br>Characters
- * to be escaped => "\ $".
+ * the <code>String::replaceAll(String regex, String replacement)</code> method. <br>
+ * Characters to be escaped are: "\ $".
*
* @param string
* The given input string.
@@ -210,7 +210,8 @@ public class StringUtil {
/**
* Converts a given input string to another string that can be used in all 'regular expression'
- * methods. <br>Characters to be escaped => "\ . $ ^ { [ ( | ) * + ?".
+ * methods. <br>
+ * Characters to be escaped are: "\ . $ ^ { [ ( | ) * + ?".
*
* @param string
* The given input string.
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/util/XMLUtil.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/util/XMLUtil.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/util/XMLUtil.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/pear/util/XMLUtil.java Mon Jan 6 20:15:45 2014
@@ -353,6 +353,8 @@ public class XMLUtil {
/**
* Prints SAX error message.
+ * @param type type
+ * @param ex exception
*/
public static void printError(String type, SAXParseException ex) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/CasManager.java Mon Jan 6 20:15:45 2014
@@ -90,7 +90,7 @@ public interface CasManager extends CasO
/**
* Gets an empty CAS. An AnalysisEngine may only call this method after it has first called
- * {@link #defineCasPool(String, int, Properties)} and established a CAS Pool of size > 0. The CAS
+ * {@link #defineCasPool(String, int, Properties)} and established a CAS Pool of size > 0. The CAS
* Manager maintains a separate pool for each AnalysisEngine. This method may block if the CAS
* pool does not contain any free instances.
*
@@ -122,6 +122,7 @@ public interface CasManager extends CasO
* The CAS
* @param requiredInterface
* interface to get. Currently must be either CAS or JCas.
+ * @return the CAS Interface
*/
AbstractCas getCasInterface(CAS cas, Class<? extends AbstractCas> requiredInterface);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ConfigurationManager.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ConfigurationManager.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ConfigurationManager.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ConfigurationManager.java Mon Jan 6 20:15:45 2014
@@ -45,6 +45,7 @@ public interface ConfigurationManager {
* corresponds to the path through the aggregate resource, e.g /subAE1/annotator1.
* @param aResourceMetaData
* metadata object containing the configuration parameter declarations and settings.
+ * @param externalSettings the external overrides
*
* @throws ResourceConfigurationException
* if the configuration settings are invalid
@@ -86,6 +87,7 @@ public interface ConfigurationManager {
* @param aQualifiedParamName
* the fully-qualified configuration parameter name. This is of the form
* <code>ContextName + / + ParameterName</code>.
+ * @param aGroupName the name of the parameter group
*
* @return the value of the parameter with the given name. The caller is expected to know the data
* type of the parameter. If the parameter does not exist,<code>null</code> is
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java Mon Jan 6 20:15:45 2014
@@ -415,7 +415,7 @@ public class ResourceInitializationExcep
/**
* Message key for a standard UIMA exception message: "The aggregate AnalysisEngine "{0}" declared
- * an empty <flowController/> element. You must specify an import or a flowControllerDescription."
+ * an empty <flowController/> element. You must specify an import or a flowControllerDescription."
*/
public static final String EMPTY_FLOW_CONTROLLER_DECLARATION = "empty_flow_controller_declaration";
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceManager.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceManager.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceManager.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceManager.java Mon Jan 6 20:15:45 2014
@@ -67,6 +67,7 @@ public interface ResourceManager {
*
* @return the absolute URL of an actual file in the datapath or classpath, null if no file
* matching <code>aRelativePath</code> is found.
+ * @throws MalformedURLException if the path cannot be converted to a URL
*/
public URL resolveRelativePath(String aRelativePath) throws MalformedURLException;
@@ -79,10 +80,11 @@ public interface ResourceManager {
* @return the Resource registered under <code>aName</code>, <code>null</code> if none
* exists.
*
- * @throws ResourceInitializationException
+ * @throws ResourceAccessException
* if the requested resource could not be initialized. A common cause is that it
* requires parameters and the {@link #getResource(String,String[])} method should have
* been called instead of this method.
+ * @throws ResourceAccessException tbd
*/
public Object getResource(String aName) throws ResourceAccessException;
@@ -98,7 +100,7 @@ public interface ResourceManager {
* @return the requested Resource, <code>null</code> if there is no resource registered under
* the name <code>aName</code>.
*
- * @throws ResourceInitializationException
+ * @throws ResourceAccessException
* if there is a resource registered under <code>aName</code> but it could not be
* instantiated for the specified parameters.
*/
@@ -279,6 +281,7 @@ public interface ResourceManager {
/**
* Gets the CasManager, which manages the creation and pooling of CASes.
+ * @return the CasManager
*/
public CasManager getCasManager();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceManagerPearWrapper.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceManagerPearWrapper.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceManagerPearWrapper.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceManagerPearWrapper.java Mon Jan 6 20:15:45 2014
@@ -35,7 +35,7 @@ public interface ResourceManagerPearWrap
* This method is called immediately after the factory creates the
* object (using the 0-argument constructor), and it initializes all
* the fields in this wrapper to share the values with their parent.
- * @param resourceManager
+ * @param resourceManager the parent ResourceManager
*/
void initializeFromParentResourceManager(ResourceManager resourceManager);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceServiceStub.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceServiceStub.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceServiceStub.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceServiceStub.java Mon Jan 6 20:15:45 2014
@@ -31,6 +31,7 @@ public interface ResourceServiceStub {
* Performs service call to retrieve resource meta data.
*
* @return metadata for the Resource
+ * @throws ResourceServiceException passthru
*/
public ResourceMetaData callGetMetaData() throws ResourceServiceException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/Session.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/Session.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/Session.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/Session.java Mon Jan 6 20:15:45 2014
@@ -36,9 +36,17 @@ import java.io.Serializable;
*
*/
public interface Session extends Serializable {
- /** Stores an object in the Session */
+ /**
+ * Stores an object in the Session
+ * @param aKey Key
+ * @param aValue Value
+ */
public void put(String aKey, Object aValue);
- /** Gets an object from the Session */
+ /**
+ * Gets an object from the Session
+ * @param aKey Key
+ * @return the associated value
+ */
public Object get(String aKey);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/ConfigurationManagerImplBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/ConfigurationManagerImplBase.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/ConfigurationManagerImplBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/ConfigurationManagerImplBase.java Mon Jan 6 20:15:45 2014
@@ -341,7 +341,7 @@ public abstract class ConfigurationManag
* name of context containing this parameter
* @param aExternalOverrides
* settings for parameters with external overrides
- * @throws ResourceConfigurationException
+ * @throws ResourceConfigurationException passthru
*/
protected void declareParameters(String aGroupName, ConfigurationParameter[] aParams,
ConfigurationParameterSettings aSettings, String aContextName, Settings aExternalOverrides)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/SessionNamespaceView_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/SessionNamespaceView_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/SessionNamespaceView_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/SessionNamespaceView_impl.java Mon Jan 6 20:15:45 2014
@@ -21,9 +21,7 @@ package org.apache.uima.resource.impl;
import org.apache.uima.resource.Session;
-/**
- *
- */
+
public class SessionNamespaceView_impl implements Session {
private static final long serialVersionUID = 7585276862479207970L;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/Session_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/Session_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/Session_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/impl/Session_impl.java Mon Jan 6 20:15:45 2014
@@ -25,9 +25,7 @@ import java.util.Map;
import org.apache.uima.resource.Session;
-/**
- *
- */
+
public class Session_impl implements Session {
private static final long serialVersionUID = -8525494546736102324L;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/Capability.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/Capability.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/Capability.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/Capability.java Mon Jan 6 20:15:45 2014
@@ -132,7 +132,7 @@ public interface Capability extends Meta
* @param aInputSofas
* an array of strings containing SofA names
*/
- /** Reserved for future use. */
+ /* Reserved for future use. */
public void setInputSofas(String[] aInputSofas);
/**
@@ -223,14 +223,14 @@ public interface Capability extends Meta
/**
* A convenience method that adds an input Sofa name to this Capability.
*
- * @param aSofaName
+ * @param aSofaName the sofa to add to the inputs
*/
public void addInputSofa(String aSofaName);
/**
* A convenience method that adds an output Sofa name to this Capability.
*
- * @param aSofaName
+ * @param aSofaName the sofa to add as an output
*/
public void addOutputSofa(String aSofaName);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationGroup.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationGroup.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationGroup.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationGroup.java Mon Jan 6 20:15:45 2014
@@ -31,7 +31,7 @@ import org.apache.uima.UIMA_UnsupportedO
public interface ConfigurationGroup extends MetaDataObject {
/**
- * Gets the group names for this <code>ConfigurationGroup</object> object.
+ * Gets the group names for this <code>ConfigurationGroup</code> object.
*
* @return an array of group names. Names are not allowed to contain
* whitespace.
@@ -39,7 +39,7 @@ public interface ConfigurationGroup exte
public String[] getNames();
/**
- * Sets the group names for this <code>ConfigurationGroup</object> object.
+ * Sets the group names for this <code>ConfigurationGroup</code> object.
*
* @param aNames an array of group names. Names are not allowed to
* contain whitespace.
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterDeclarations.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterDeclarations.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterDeclarations.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterDeclarations.java Mon Jan 6 20:15:45 2014
@@ -238,8 +238,8 @@ public interface ConfigurationParameterD
* A value for the <code>searchStrategy</code> property that is useful when ISO language and
* country codes are used as configuration group names. If there is no value declared in a group,
* look in more general groups. The fallback sequence is
- * <code>lang-country-region -> lang-country ->
- * lang -> default</code>. For example, if a
+ * <code>lang-country-region -%gt; lang-country -%gt;
+ * lang -%gt; default</code>. For example, if a
* request is made for the value of a parameter in the "en-GB" group and no such group exists, the
* value from the "en" group will be used instead.
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ExternalResourceBinding_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ExternalResourceBinding_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ExternalResourceBinding_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ExternalResourceBinding_impl.java Mon Jan 6 20:15:45 2014
@@ -28,9 +28,7 @@ import org.apache.uima.resource.metadata
public class ExternalResourceBinding_impl extends MetaDataObject_impl implements
ExternalResourceBinding {
- /**
- *
- */
+
private static final long serialVersionUID = 8736222753308388218L;
private String mResourceName;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/Import_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/Import_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/Import_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/Import_impl.java Mon Jan 6 20:15:45 2014
@@ -37,9 +37,7 @@ import org.xml.sax.helpers.AttributesImp
*
*/
public class Import_impl extends MetaDataObject_impl implements Import {
- /**
- *
- */
+
private static final long serialVersionUID = 6876757002913848998L;
private String mName;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java Mon Jan 6 20:15:45 2014
@@ -865,7 +865,7 @@ public abstract class MetaDataObject_imp
* namespace for this object
* @param aContentHandler
* ContentHandler to which this object will send events describing its XML representation
- * @throws SAXException
+ * @throws SAXException passthru
*/
protected void writeMapPropertyToXml(String aPropName, String aXmlElementName,
@@ -1397,10 +1397,10 @@ public abstract class MetaDataObject_imp
* maybeOutputCommentsAfter
*
* Detect top level (by fact that parent is null), and for top level:
- * collect all above -> output before startelement
+ * collect all above -%gt; output before startelement
* BUT, note that the sax parser doesn't do callbacks for text (blank lines) before the
* start element, so all we can collect are the comment lines.
- * collect all below -> output after endelement
+ * collect all below -%gt; output after endelement
*
* For normal element node, "start":
* --> output before element
@@ -1532,9 +1532,9 @@ public abstract class MetaDataObject_imp
* <someElement> some text
*
* @param startNode - the node corresponding to the start or end element just outputted
- * @param contentHandler
- * @throws DOMException
- * @throws SAXException
+ * @param contentHandler the content handler
+ * @throws DOMException passthru
+ * @throws SAXException passthru
*/
private void outputCoIwAfterElement(Node startNode, ContentHandler contentHandler) throws DOMException, SAXException {
if (null != startNode) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/search/Filter.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/search/Filter.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/search/Filter.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/search/Filter.java Mon Jan 6 20:15:45 2014
@@ -36,7 +36,7 @@ import org.apache.uima.util.XMLizable;
* The only syntax the indexers are required to import is the <code>FeatureValue</code> syntax,
* which permits very simple expressions that test the values of features. Expressions using this
* syntax take the form <code><FeatureName> <Operator> <Literal></code>, where
- * FeatureName is a CAS feature name, Operator is either =, !=, <, <=, >, or >=, and
+ * FeatureName is a CAS feature name, Operator is either =, !=, <, <=, >, or ≥=, and
* Literal is an integer, floating point number (no exponent syntax supported) or string literal
* enclosed in double quotes, with embedded quotes and backslashes escaped by a backslash. For
* example, the following are valid filters:
@@ -44,7 +44,7 @@ import org.apache.uima.util.XMLizable;
* <li>foo = "hello world"</li>
* <li>foo < 42 </li>
* <li>bar7 = "\"Blah,\" he said."
- * <li>bar7 >= 0.5</li>
+ * <li>bar7 >= 0.5</li>
* </ul>
* This object implements the {@link XMLizable} interface and can be parsed from an XML
* representation.
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/search/impl/Mapping_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/search/impl/Mapping_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/search/impl/Mapping_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/search/impl/Mapping_impl.java Mon Jan 6 20:15:45 2014
@@ -24,9 +24,7 @@ import org.apache.uima.resource.metadata
import org.apache.uima.resource.metadata.impl.XmlizationInfo;
import org.apache.uima.search.Mapping;
-/**
- *
- */
+
public class Mapping_impl extends MetaDataObject_impl implements Mapping {
private static final long serialVersionUID = -2371976614485187381L;
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=1556016&r1=1556015&r2=1556016&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 Mon Jan 6 20:15:45 2014
@@ -302,9 +302,7 @@ public class UimacppAnalysisComponent ex
return 1;
}
- /**
- *
- */
+
public void batchProcessComplete() throws AnalysisEngineProcessException {
try {
if (engine != null) {
@@ -316,9 +314,7 @@ public class UimacppAnalysisComponent ex
}
}
- /**
- *
- */
+
public void collectionProcessComplete() throws AnalysisEngineProcessException {
try {
if (engine != null) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasCreationUtils.java Mon Jan 6 20:15:45 2014
@@ -344,7 +344,8 @@ public class CasCreationUtils {
* @param aPerformanceTuningSettings
* Properties object containing framework performance tuning settings using key
* names defined on {@link UIMAFramework} interface
- *
+ * @param aResourceManager
+ * the resource manager
* @return a new CAS instance
*
* @throws ResourceInitializationException
@@ -473,7 +474,8 @@ public class CasCreationUtils {
* type priorities to install in the CAS
* @param aFsIndexes
* indexes to install in the CAS
- *
+ * @param aPerformanceTuningSettings
+ * the settings for performance tuning
* @return a new CAS instance
*
* @throws ResourceInitializationException
@@ -495,6 +497,8 @@ public class CasCreationUtils {
* type priorities to install in the CAS
* @param aFsIndexes
* indexes to install in the CAS
+ * @param aPerformanceTuningSettings
+ * the settings for performance tuning
* @param aResourceManager
* resource manager, which is used to set the JCas ClassLoader for the new CAS
*
@@ -1896,7 +1900,7 @@ public class CasCreationUtils {
* information in all of the objects in <code>aComponentDescriptionOrMetaData</code>
* (including all components of aggregate AnalysisEngines)
*
- * @throws ResourceInitialziationException
+ * @throws ResourceInitializationException
* if a failure occurs because an import could not be resolved
*/
public static List<ProcessingResourceMetaData> getMetaDataList(Collection<? extends MetaDataObject> aComponentDescriptionOrMetaData,
@@ -2061,7 +2065,7 @@ public class CasCreationUtils {
* information in all of the objects in <code>aComponentDescriptionOrMetaData</code>
* (including all components of aggregate AnalysisEngines)
*
- * @throws ResourceInitialziationException
+ * @throws ResourceInitializationException
* if a failure occurs because an import could not be resolved
*/
public static List<ProcessingResourceMetaData> getMetaDataList(Collection<? extends MetaDataObject> aComponentDescriptionOrMetaData,
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasPool.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasPool.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasPool.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/CasPool.java Mon Jan 6 20:15:45 2014
@@ -136,7 +136,7 @@ public class CasPool {
* the number of CAS instances in the pool
* @param aMetaData
* metadata that includes the type system for the CAS
- *
+ * @param aResourceManager Resource Manager
* @throws ResourceInitializationException
* if the CAS instances could not be created
*/
@@ -161,6 +161,7 @@ public class CasPool {
* @param aPerformanceTuningSettings
* Properties object containing framework performance tuning settings using key names
* defined on {@link UIMAFramework} interface
+ * @throws ResourceInitializationException -
*/
public CasPool(int aNumInstances, CasDefinition aCasDefinition,
Properties aPerformanceTuningSettings) throws ResourceInitializationException {
@@ -180,6 +181,7 @@ public class CasPool {
* @param aPerformanceTuningSettings
* Properties object containing framework performance tuning settings using key names
* defined on {@link UIMAFramework} interface
+ * @throws ResourceInitializationException -
*/
public CasPool(int aNumInstances, CasManager aCasManager,
Properties aPerformanceTuningSettings) throws ResourceInitializationException {
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=1556016&r1=1556015&r2=1556016&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 Mon Jan 6 20:15:45 2014
@@ -74,6 +74,8 @@ 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
*/
public String format(CAS aCAS) throws CASException {
return generateXML(aCAS, null);
@@ -81,6 +83,10 @@ public class CasToInlineXml {
/**
* Formats a CAS as a String. Only FeatureStructures matching the given filter will be output.
+ * @param aCAS CAS
+ * @param aFilter a filter to limit the Feature Structures
+ * @return the XML representation
+ * @throws CASException -
*/
public String format(CAS aCAS, FSMatchConstraint aFilter) throws CASException {
return generateXML(aCAS, aFilter);
@@ -91,6 +97,7 @@ public class CasToInlineXml {
*
* @param aCAS
* CAS to generate from
+ * @return the inline XML version of the CAS
*/
public String generateXML(CAS aCAS) throws CASException {
return generateXML(aCAS, null);
@@ -104,6 +111,8 @@ public class CasToInlineXml {
* @param aFilter
* constraint that determines which annotations are included in the output. If null (or
* omitted), all annotations are included.
+ * @return the inline XML version of the CAS
+ * @throws CASException -
*/
public String generateXML(CAS aCAS, FSMatchConstraint aFilter) throws CASException {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/FileUtils.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/FileUtils.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/FileUtils.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/FileUtils.java Mon Jan 6 20:15:45 2014
@@ -350,6 +350,7 @@ public class FileUtils {
* @param relativeToDir
* directory that the path should be relative to
* @return a relative path. This always uses / as the separator character.
+ * @throws IOException -
*/
public static String findRelativePath(File file, File relativeToDir) throws IOException {
String canonicalFile = file.getCanonicalPath();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/Settings.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/Settings.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/Settings.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/Settings.java Mon Jan 6 20:15:45 2014
@@ -50,7 +50,7 @@ public interface Settings {
* can span multiple lines without using a final \
*
* @param in - Stream holding properties
- * @throws IOException
+ * @throws IOException if name characters illegal
*/
public void load(InputStream in) throws IOException;
@@ -59,7 +59,7 @@ public interface Settings {
* UimaExternalOverrides
* Files are loaded in order --- so in descending priority.
*
- * @throws ResourceConfigurationException
+ * @throws ResourceConfigurationException wraps IOException
*/
public void loadSystemDefaults() throws ResourceConfigurationException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/SimpleResourceFactory.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/SimpleResourceFactory.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/SimpleResourceFactory.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/SimpleResourceFactory.java Mon Jan 6 20:15:45 2014
@@ -191,6 +191,7 @@ public class SimpleResourceFactory imple
* @param aResourceClassName
* the name of a subclass of <code>Resource</code> that is to be instantiated from
* resource specifiers of the given class.
+ * @throws ClassNotFoundException -
*/
@SuppressWarnings("unchecked")
public void addMapping(String aSpecifierInterfaceName, String aResourceClassName)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/TCasToInlineXml.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/TCasToInlineXml.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/TCasToInlineXml.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/TCasToInlineXml.java Mon Jan 6 20:15:45 2014
@@ -51,7 +51,7 @@ import org.xml.sax.helpers.AttributesImp
*/
@Deprecated
public class TCasToInlineXml implements TCasFormatter {
- /**
+ /*
* This destroy method does nothing.
*
* @see org.apache.uima.resource.Resource#destroy()
@@ -59,21 +59,21 @@ public class TCasToInlineXml implements
public void destroy() {
}
- /**
+ /*
* @see org.apache.uima.util.TCasFormatter#format(CAS)
*/
public String format(CAS aCAS) throws CASException {
return generateXML(aCAS, null);
}
- /**
+ /*
* @see org.apache.uima.util.TCasFormatter#format(CAS, FSMatchConstraint)
*/
public String format(CAS aCAS, FSMatchConstraint aFilter) throws CASException {
return generateXML(aCAS, aFilter);
}
- /**
+ /*
* Generates inline XML from a CAS.
*
* @param aCAS
@@ -83,7 +83,7 @@ public class TCasToInlineXml implements
return generateXML(aCAS, null);
}
- /**
+ /*
* Generates inline XML from a CAS.
*
* @param aCAS
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/TypeSystemUtil.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/TypeSystemUtil.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/TypeSystemUtil.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/TypeSystemUtil.java Mon Jan 6 20:15:45 2014
@@ -136,6 +136,7 @@ public class TypeSystemUtil {
*
* @param aType
* the type, which must be a subtype of uima.cas.String
+ * @param aTypeSystem the type system to use
* @return array of allowed values for <code>aType</code> TODO - this should be a method on
* Type.
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/UriUtils.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/UriUtils.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/UriUtils.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/UriUtils.java Mon Jan 6 20:15:45 2014
@@ -38,9 +38,9 @@ public class UriUtils {
* String has quoted (e.g. %20) characters but no other chars needing quoting
* String has quoted (e.g. %20) characters and chars needing quoting, not currently quoted
* -- this case will throw an exception
- * @param s
+ * @param s the string to quote
* @return URI with proper quoting
- * @throws URISyntaxException
+ * @throws URISyntaxException passthru
*/
public static URI quote (String s) throws URISyntaxException {
if (-1 == s.indexOf('%')) {
@@ -56,9 +56,9 @@ public class UriUtils {
/**
* Create a URI from a URL, with proper quoting.
* Already quoted things in the input string are not re-quoted.
- * @param u
+ * @param u the input URL
* @return URI with proper quoting
- * @throws URISyntaxException
+ * @throws URISyntaxException passthru
*/
public static URI quote(URL u) throws URISyntaxException {
@@ -69,7 +69,7 @@ public class UriUtils {
* Create a URI from a String, with proper quoting.
* Already quoted things in the input string are not re-quoted.
* Mimic exception treatment of URI.create
- * @param s
+ * @param s the input string
* @return URI with proper quoting
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLizable.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLizable.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLizable.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLizable.java Mon Jan 6 20:15:45 2014
@@ -43,7 +43,7 @@ public interface XMLizable {
* instead, as it ensures that output is written in UTF-8 encoding, which is the default encoding
* that should be used for XML files.
* <p>
- * The XML String that is produced will have a header <code><?xml version="1.0" encoding="UTF-8"?></code>.
+ * The XML String that is produced will have a header <code><?xml version="1.0" encoding="UTF-8"?></code>.
* Therefore you should not write this string out in any encoding other than UTF-8 (for example do not use the
* default platform encoding), or you will produce output that will not be able to be parsed.
*
@@ -52,6 +52,7 @@ public interface XMLizable {
*
* @throws IOException
* if an I/O failure occurs
+ * @throws SAXException passthru
*/
public void toXML(Writer aWriter) throws SAXException, IOException;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/DataIO.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/DataIO.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/DataIO.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/DataIO.java Mon Jan 6 20:15:45 2014
@@ -95,11 +95,11 @@ public class DataIO {
* For DataOutput, DataInput
***************************************************************************************/
/**
- * Similar to writeUTF, but ok for strings > 32K bytes long and better for strings < 127
- * string utf-8 length must be <= Integer.MAX_VALUE - 1
- * @param string
- * @param out
- * @throws IOException
+ * Similar to writeUTF, but ok for strings > 32K bytes long and better for strings < 127
+ * string utf-8 length must be ≤ Integer.MAX_VALUE - 1
+ * @param string the string to write
+ * @param out the output sink
+ * @throws IOException passthru
*/
public static void writeUTFv(String string, DataOutput out) throws IOException {
if (null == string) {
@@ -139,9 +139,9 @@ public class DataIO {
/**
* DataOutputStream writeShort with checking of argument
- * @param out
- * @param v
- * @throws IOException
+ * @param out the output sink
+ * @param v the value to write
+ * @throws IOException passthru
*/
public static void writeShort(DataOutput out, int v) throws IOException {
if (v > Short.MAX_VALUE ||
@@ -154,9 +154,9 @@ public class DataIO {
/**
* DataOutputStream writeByte with checking of argument
- * @param out
- * @param v
- * @throws IOException
+ * @param out output sink
+ * @param v the value to write
+ * @throws IOException passthru
*/
public static void writeByte(DataOutput out, int v) throws IOException {
if (v > Byte.MAX_VALUE ||
@@ -169,9 +169,9 @@ public class DataIO {
/**
* Write lower 8 bits
- * @param out
- * @param v
- * @throws IOException
+ * @param out output sink
+ * @param v the value to write
+ * @throws IOException passthru
*/
public static void writeUnsignedByte(DataOutput out, int v) throws IOException {
out.write(v);
@@ -181,9 +181,9 @@ public class DataIO {
* write a positive or negative number, optimized for fewer bytes near 0
* sign put in low order bit, rest of number converted to positive and shifted left 1
* max negative written as - 0.
- * @param out
- * @param v
- * @throws IOException
+ * @param out output sink
+ * @param v the value to write
+ * @throws IOException passthru
*/
// special handling for MIN_VALUE because
// Math.abs of it "fails". We instead code it as
@@ -250,9 +250,9 @@ public class DataIO {
*
* Note: value treated as unsigned 32 bit int
*
- * @param out
- * @param v
- * @throws IOException
+ * @param out output sink
+ * @param v the value to write
+ * @throws IOException passthru
*/
public static void writeVnumber(final DataOutput out, final int v) throws IOException {
if ((v >= 0) && v < 128) {
@@ -312,9 +312,9 @@ public class DataIO {
* Write a positive long with the fewest bytes possible; up to 127 written as a byte, high order
* bit on means get another byte.
*
- * @param out
- * @param v is never negative
- * @throws IOException
+ * @param out output sink
+ * @param v the value to write is never negative
+ * @throws IOException passthru
*/
public static void writeVnumber(final DataOutput out, final long v) throws IOException {
if ((v >= 0) && v < 128) {
@@ -403,9 +403,9 @@ public class DataIO {
/**
* write array preceded by its length
- * @param out
- * @param v
- * @throws IOException
+ * @param out output sink
+ * @param v the value to write
+ * @throws IOException passthru
*/
public static void writeIntArray(DataOutput out, int[] v) throws IOException {
writeVnumber(out, v.length);
@@ -425,9 +425,9 @@ public class DataIO {
/**
* Write delta encoded value, for increasing values
- * @param out
- * @param v
- * @throws IOException
+ * @param out output sink
+ * @param v the value to write
+ * @throws IOException passthru
*/
public static void writeIntArrayDelta(DataOutput out, int[] v) throws IOException {
writeVnumber(out, v.length);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/JSR47Logger_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/JSR47Logger_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/JSR47Logger_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/JSR47Logger_impl.java Mon Jan 6 20:15:45 2014
@@ -446,8 +446,8 @@ public class JSR47Logger_impl implements
/**
* JSR-47 level mapping to UIMA level mapping.
*
- * SEVERE (highest value) -> SEVERE WARNING -> WARNING INFO -> INFO CONFIG -> CONFIG FINE -> FINE
- * FINER -> FINER FINEST (lowest value) -> FINEST OFF -> OFF ALL -> ALL
+ * SEVERE (highest value) -%gt; SEVERE WARNING -%gt; WARNING INFO -%gt; INFO CONFIG -%gt; CONFIG FINE -%gt; FINE
+ * FINER -%gt; FINER FINEST (lowest value) -%gt; FINEST OFF -%gt; OFF ALL -%gt; ALL
*
* @param level
* uima level
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/Log4jLogger_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/Log4jLogger_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/Log4jLogger_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/Log4jLogger_impl.java Mon Jan 6 20:15:45 2014
@@ -414,8 +414,8 @@ public class Log4jLogger_impl implements
/**
* log4j level mapping to UIMA level mapping. SEVERE (highest value) ->
- * SEVERE WARNING -> WARNING INFO -> INFO CONFIG -> CONFIG FINE -> FINE FINER ->
- * FINER FINEST (lowest value) -> FINEST OFF -> OFF ALL -> ALL
+ * SEVERE WARNING -%gt; WARNING INFO -%gt; INFO CONFIG -%gt; CONFIG FINE -%gt; FINE FINER ->
+ * FINER FINEST (lowest value) -%gt; FINEST OFF -%gt; OFF ALL -%gt; ALL
*
* @param level
* uima level
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/Settings_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/Settings_impl.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/Settings_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/Settings_impl.java Mon Jan 6 20:15:45 2014
@@ -81,7 +81,7 @@ public class Settings_impl implements Se
* May be called multiple times.
*
* @param in - Stream holding properties
- * @throws IOException
+ * @throws IOException if name characters illegal
*/
public void load(InputStream in) throws IOException {
// Process each logical line (after blanks & comments removed and continuations extended)
@@ -125,7 +125,7 @@ public class Settings_impl implements Se
/**
* Load the files specified in the system property UimaExternalOverrides
*
- * @throws ResourceConfigurationException
+ * @throws ResourceConfigurationException wraps IOException
*/
public void loadSystemDefaults() throws ResourceConfigurationException {
@@ -162,7 +162,7 @@ public class Settings_impl implements Se
*
* @param name - name to look up
* @return - value of property
- * @throws ResourceConfigurationException
+ * @throws ResourceConfigurationException if override variable references undefined variable
*/
public String lookUp(String name) throws ResourceConfigurationException {
String value;
@@ -199,7 +199,7 @@ public class Settings_impl implements Se
/*
* Create a string representing an array from one or more logical lines
- * Assert: line length > 0
+ * Assert: line length > 0
*/
private String getArray(String line) throws IOException {
int iend = line.indexOf(']');
@@ -274,7 +274,7 @@ public class Settings_impl implements Se
/*
* Check if a character in the string is escaped, i.e. preceded by an odd number of '\'s
- * Correctly returns false if ichar <= 0
+ * Correctly returns false if ichar ≤ 0
*/
private boolean isEscaped(String line, int ichar) {
int i = ichar - 1;
Modified: uima/uimaj/trunk/uimaj-core/src/test/java/aa/AbstractType.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/test/java/aa/AbstractType.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/test/java/aa/AbstractType.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/test/java/aa/AbstractType.java Mon Jan 6 20:15:45 2014
@@ -55,7 +55,7 @@ public class AbstractType extends TOP {
protected AbstractType() {
}
- /*
+ /**
* Internal - constructor used by generator
*
* @generated
@@ -82,7 +82,7 @@ public class AbstractType extends TOP {
// *--------------*
// * Feature: abstractInt
- /*
+ /**
* getter for abstractInt - gets
*
* @generated
@@ -94,7 +94,7 @@ public class AbstractType extends TOP {
((AbstractType_Type) jcasType).casFeatCode_abstractInt);
}
- /*
+ /**
* setter for abstractInt - sets
*
* @generated
Modified: uima/uimaj/trunk/uimaj-core/src/test/java/aa/ConcreteType.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/test/java/aa/ConcreteType.java?rev=1556016&r1=1556015&r2=1556016&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/test/java/aa/ConcreteType.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/test/java/aa/ConcreteType.java Mon Jan 6 20:15:45 2014
@@ -54,7 +54,7 @@ public class ConcreteType extends Abstra
protected ConcreteType() {
}
- /*
+ /**
* Internal - constructor used by generator
*
* @generated
@@ -81,7 +81,7 @@ public class ConcreteType extends Abstra
// *--------------*
// * Feature: concreteString
- /*
+ /**
* getter for concreteString - gets
*
* @generated
@@ -94,7 +94,7 @@ public class ConcreteType extends Abstra
((ConcreteType_Type) jcasType).casFeatCode_concreteString);
}
- /*
+ /**
* setter for concreteString - sets
*
* @generated