You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2013/12/09 20:14:17 UTC
svn commit: r1549649 - in
/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima:
resource/metadata/ resource/metadata/impl/ uimacpp/ util/
Author: schor
Date: Mon Dec 9 19:14:17 2013
New Revision: 1549649
URL: http://svn.apache.org/r1549649
Log:
[UIMA-3484] javadoc fixes
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterSettings.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/MetaDataObject.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ProcessingResourceMetaData_impl.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/util/CasCreationUtils.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/NameClassPair.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLizable.java
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterSettings.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterSettings.java?rev=1549649&r1=1549648&r2=1549649&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterSettings.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/ConfigurationParameterSettings.java Mon Dec 9 19:14:17 2013
@@ -71,7 +71,7 @@ public interface ConfigurationParameterS
*
* @param aGroupName
* the name of a configuration group. If this parameter is
- * <code>null<code>, this method will return the same value as
+ * <code>null</code>, this method will return the same value as
* {@link #getParameterValue(String)}.
* @param aParamName the name of a parameter in the group
*
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/MetaDataObject.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/MetaDataObject.java?rev=1549649&r1=1549648&r2=1549649&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/MetaDataObject.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/MetaDataObject.java Mon Dec 9 19:14:17 2013
@@ -126,9 +126,9 @@ public interface MetaDataObject extends
/**
* If the sourceURL of this object is non-null, returns its string representation. If it is null,
- * returns "<unknown>". Useful for error messages.
+ * returns "<unknown>". Useful for error messages.
*
- * @return the source URL as a string, or "<unknown>"
+ * @return the source URL as a string, or "<unknown>"
*/
public String getSourceUrlString();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ProcessingResourceMetaData_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ProcessingResourceMetaData_impl.java?rev=1549649&r1=1549648&r2=1549649&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ProcessingResourceMetaData_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/ProcessingResourceMetaData_impl.java Mon Dec 9 19:14:17 2013
@@ -26,9 +26,9 @@ import org.apache.uima.resource.metadata
* Reference implementation of {@link ProcessingResourceMetaData}. This class only exists for
* historical reasons. It inherits almost everything from AnalysisEngineMetaData_impl. The only
* reason we need this class is because its XML tag name needs to be
- * <processingResourceMetaData>, not
+ * <processingResourceMetaData>, not
*
- * <analysisEngienMetaData>, for compatibility with existing descriptors.
+ * <analysisEngienMetaData>, for compatibility with existing descriptors.
*/
public class ProcessingResourceMetaData_impl extends AnalysisEngineMetaData_impl implements
ProcessingResourceMetaData {
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=1549649&r1=1549648&r2=1549649&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 Dec 9 19:14:17 2013
@@ -90,7 +90,8 @@ public class UimacppAnalysisComponent ex
}
/**
- * @throws ResourceInitializationException
+ * @param context the UIMA Context
+ * @throws ResourceInitializationException wraps exceptions thrown from called routines
* @see org.apache.uima.analysis_component.AnalysisComponent#initialize(org.apache.uima.UimaContext)
*/
public void initialize(UimaContext context) throws ResourceInitializationException {
@@ -171,6 +172,8 @@ 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
*/
public void typeSystemInit(TypeSystem ts) throws AnnotatorConfigurationException,
AnnotatorInitializationException {
@@ -193,6 +196,9 @@ public class UimacppAnalysisComponent ex
/**
* @see org.apache.uima.analysis_engine.annotator.GenericAnnotator#process(CAS, ResultSpecification)
+ * @param cas the CAS to process
+ * @param aResultSpec the Result Specification to use
+ * @throws AnnotatorProcessException wraps exceptions thrown from called methods
*/
public void process(CAS cas, ResultSpecification aResultSpec) throws AnnotatorProcessException {
try {
@@ -357,6 +363,7 @@ public class UimacppAnalysisComponent ex
/**
* Get the logging level of the logger for TAFAnnotator. TAF only supports three levels of
* logging. All logging levels INFO and below are mapped to the TAF message level.
+ * @return the logging level
*/
public static int getLoggingLevel() {
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=1549649&r1=1549648&r2=1549649&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 Mon Dec 9 19:14:17 2013
@@ -108,7 +108,7 @@ public class UimacppEngine {
private native void resetJNI() throws InternalTafException;
- /**
+ /*
* private native void fillCASJNI(int[] heapArray, int[] fsIndex, String[] stringTable);
*/
private native void fillCASJNI(int[] heapArray, int[] fsIndex, String[] stringTable,
@@ -196,6 +196,9 @@ public class UimacppEngine {
/**
* Configure the TAF Resource Manager.
+ * @param workDirectory the work directory
+ * @param dataDirectory the data directory
+ * @throws UimacppException wraps any exception
*/
public static void configureResourceManager(String workDirectory, String dataDirectory)
throws UimacppException {
@@ -220,6 +223,8 @@ public class UimacppEngine {
/**
* create a TAF engine with a config file
+ * @param configFile the configuration file used for initialization
+ * @throws UimacppException pass thru
*/
public static UimacppEngine createJTafTAE(String configFile) throws UimacppException {
UimacppEngine result = new UimacppEngine();
@@ -291,6 +296,7 @@ public class UimacppEngine {
/**
* de-initializes the TAF engine.
+ * @throws UimacppException wraps any exception
*/
public void destroy() throws UimacppException {
try {
@@ -317,6 +323,10 @@ public class UimacppEngine {
/**
* process the document.
+ * @param rs the result specification
+ * @param aCas the CAS
+ * @param casIsEmpty tbd
+ * @throws UimacppException wraps any exception
*/
public void process(ResultSpecification rs, CAS aCas, boolean casIsEmpty) throws UimacppException {
@@ -366,6 +376,8 @@ public class UimacppEngine {
/**
* hasNext
+ * @return true if there's a next element
+ * @throws UimacppException wraps any exception
*/
public boolean hasNext() throws UimacppException {
@@ -399,6 +411,8 @@ public class UimacppEngine {
/**
* next
+ * @param segment tbd
+ * @throws UimacppException wraps any exception
*/
public void next(CAS segment) throws UimacppException {
@@ -437,6 +451,7 @@ public class UimacppEngine {
/**
* batchProcessComplete
+ * @throws UimacppException wraps any exception
*/
public void batchProcessComplete() throws UimacppException {
try {
@@ -448,6 +463,7 @@ public class UimacppEngine {
/**
* CasConsumer collectionProcessComplete
+ * @throws UimacppException wraps any exception
*/
public void collectionProcessComplete() throws UimacppException {
try {
@@ -459,6 +475,9 @@ public class UimacppEngine {
/**
* helper function to get the error message for some TAF error ID.
+ * @param errorCode the code used as the key to look up the error message
+ * @return the error message
+ * @throws UimacppException wraps any exception
*/
public static String getErrorMessage(long errorCode) throws UimacppException {
try {
@@ -471,6 +490,7 @@ public class UimacppEngine {
/**
* helper function to get the TAF JNI version.
+ * @throws UimacppException wraps any exception
*/
public static String getTafJNIVersion() throws UimacppException {
try {
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=1549649&r1=1549648&r2=1549649&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 Dec 9 19:14:17 2013
@@ -630,6 +630,9 @@ public class CasCreationUtils {
* names defined on {@link UIMAFramework} interface
*
* @return a new CAS matching the given CasDefinition
+ * @throws ResourceInitializationException
+ * if CAS creation fails
+
*/
public static CAS createCas(CasDefinition casDef, Properties performanceTuningSettings)
throws ResourceInitializationException {
@@ -649,6 +652,8 @@ public class CasCreationUtils {
* type system object to reuse
*
* @return a new CAS matching the given CasDefinition
+ * @throws ResourceInitializationException
+ * if CAS creation fails
*/
public static CAS createCas(CasDefinition casDef, Properties performanceTuningSettings,
TypeSystem typeSystem) throws ResourceInitializationException {
@@ -842,7 +847,7 @@ public class CasCreationUtils {
* @param aTypePriorities
* description of the type priorities to add
*
- * @throws CASException
+ * @throws ResourceInitializationException
* if an error occurs during type priority setup
*/
public static void setupTypePriorities(CASMgr aCASMgr, TypePriorities aTypePriorities)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/NameClassPair.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/NameClassPair.java?rev=1549649&r1=1549648&r2=1549649&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/NameClassPair.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/NameClassPair.java Mon Dec 9 19:14:17 2013
@@ -91,7 +91,7 @@ public class NameClassPair implements ja
/**
* Gets the hash code for this object. The hash codes of two NameClassPairs <code>x</code> and
- * </code>y</code> must be equal if <code>x.equals(y)</code> returns true;
+ * <code>y</code> must be equal if <code>x.equals(y)</code> returns true;
*
* @return the hash code for this object
*/
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java?rev=1549649&r1=1549648&r2=1549649&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/XMLParser.java Mon Dec 9 19:14:17 2013
@@ -726,7 +726,7 @@ public interface XMLParser {
* <p>
* This method is similar to {@link #buildObject(Element, XMLParser.ParsingOptions)} but can also
* parse primitive-typed objects wrapped as XML elements, such as
- * <code><integer>42</integer</code>.
+ * <code><integer>42</integer</code>.
*
* @param aElement
* a DOM Element
@@ -756,8 +756,6 @@ public interface XMLParser {
* @return an object that implements {@link org.xml.sax.ContentHandler} and can be used to
* deserialize an {@link XMLizable} object from SAX events.
*
- * @throws InvalidXMLException
- * if the XML element does not specify a valid object
*/
public SaxDeserializer newSaxDeserializer();
@@ -770,8 +768,6 @@ public interface XMLParser {
* @return an object that implements {@link org.xml.sax.ContentHandler} and can be used to
* deserialize an {@link XMLizable} object from SAX events.
*
- * @throws InvalidXMLException
- * if the XML element does not specify a valid object
* @see #newSaxDeserializer()
*
*/
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=1549649&r1=1549648&r2=1549649&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 Dec 9 19:14:17 2013
@@ -63,6 +63,7 @@ public interface XMLizable {
*
* @throws IOException
* if an I/O failure occurs
+ * @throws SAXException pass thru
*/
public void toXML(OutputStream aOutputStream) throws SAXException, IOException;
@@ -75,8 +76,7 @@ public interface XMLizable {
* the content handler to which this object will write events that describe its XML
* representation.
*
- * @throws IOException
- * if an I/O failure occurs
+ * @throws SAXException pass thru
*/
public void toXML(ContentHandler aContentHandler) throws SAXException;
@@ -90,8 +90,7 @@ public interface XMLizable {
* whether the namespace of this element should be written as the default namespace. This
* should be done only for the root element, and it defaults to false.
*
- * @throws IOException
- * if an I/O failure occurs
+ * @throws SAXException pass thru
*/
public void toXML(ContentHandler aContentHandler, boolean aWriteDefaultNamespaceAttribute)
throws SAXException;