Author: schor
Date: Mon Nov 2 20:33:00 2015
New Revision: 1712143
URL: http://svn.apache.org/viewvc?rev=1712143&view=rev
Log:
[UIMA-4670] exception support javadocs
Modified:
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/package.html
Modified:
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/package.html
URL:
http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/package.html?rev=1712143&r1=1712142&r2=1712143&view=diff
==============================================================================
---
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/package.html
(original)
+++
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/package.html
Mon Nov 2 20:33:00 2015
@@ -19,8 +19,27 @@
***************************************************************
-->
<html>
-<body>The main package for the Unstructured Information Management Middleware
-Architecture. The {@link org.apache.uima.UIMAFramework} class provides the
primary
-interface point for applications.
+<body>
+<h1>Apache UIMA</h1>
+<p>This package contains:</p>
+<ul>
+<li>The {@link org.apache.uima.UIMAFramework} class provides the primary
interface point for applications.</li>
+<li>Most of the error / exception indirection classes (to allow IDEs to do
auto-complete looking for messages).</li>
+</ul>
+<h2>Internationalized Exceptions and Messages</h2>
+<p>Internationalization is handled by the static methods in I18nUtil.
These are called by the Internationalized Exceptions, but may be also
used for non-exception message localization.</p>
+<p>Exception messages are collected into classes. These classes may be
organized further into hierarchies, but the top of these extend one of the
following 3 classes:</p>
+<ul>
+<li>Exception - for checked exceptions</li>
+<li>RuntimeException - for unchecked exceptions</li>
+<li>SaxException - for exceptions thrown during Sax related callbacks
requiring SaxExceptions be thrown</li>
+</ul>
+<p>Common code for getting a localized message from arguments and message key
and resource bundle are put in the interface I18nExceptionI as default methods.
Using default methods allows shared methods to be used with different
superclass chains.</p>
+<p>The individual classes:</p>
+<ul>
+<li>hold static public MSG_NAME = "prop-file-key-name" values, allow IDE
search via completion, allows renaming via Eclipse refactorization</li>
+<li>Classes collect messages for some sub-section of the code</li>
+<li>Super class structure can supply common resource bundles</li>
+</ul>
</body>
</html>
