Added logging and Unchecked exceptions

markjschreiber · andreasprlic · commit 0ed14f54b199 · 2016-04-09T10:58:28.000-07:00
diff --git a/_wikis/BioJava3_Design.md b/_wikis/BioJava3_Design.md
@@ -58,6 +58,17 @@ Basic principles
     getTopBlastHit()).
 -   The source code license will be the GNU Lesser General Public
     License (LGPL) "version 2.1 or any later version".
+-   In general BJ3 exceptions should be RuntimeExceptions and unchecked.
+    They should also be well documented and give useful messages. It
+    should be up to the developer to decide what to capture and what not
+    to. In the current BioJava there are way to many exceptions that
+    can't really happen under any normal circumstances. We should only
+    need to think about exceptions in exceptional circumstances.
+-   The default Java logging API should be used extensively. This will
+    allow a developer the ability to fine tune debugging. The core
+    module should have a logging helper with static convenience methods
+    to make it very easy to liberally use logging calls via static
+    imports.
 
 Compromises and Unfinished bits
 -------------------------------
diff --git a/_wikis/BioJava3_Design.mediawiki b/_wikis/BioJava3_Design.mediawiki
@@ -25,6 +25,8 @@ This document was based on comments made on the following pages:
 * Always ALWAYS correctly implement equals, compareTo, hashCode, and Serializable wherever possible.
 * Any general-use methods to be exposed via SPI (e.g. getTopBlastHit()).
 * The source code license will be the GNU Lesser General Public License (LGPL) "version 2.1 or any later version".
+* In general BJ3 exceptions should be RuntimeExceptions and unchecked. They should also be well documented and give useful messages. It should be up to the developer to decide what to capture and what not to. In the current BioJava there are way to many exceptions that can't really happen under any normal circumstances. We should only need to think about exceptions in exceptional circumstances.
+* The default Java logging API should be used extensively. This will allow a developer the ability to fine tune debugging. The core module should have a logging helper with static convenience methods to make it very easy to liberally use logging calls via static imports.
 
 ==Compromises and Unfinished bits==
 * TestNG was suggested instead of JUnit, but knowledge of this tool is not so widespread and this may impact on quality of testing.
