Revision: 1503
http://svn.sourceforge.net/spring-rich-c/?rev=1503&view=rev
Author: ge0ffrey
Date: 2006-10-11 00:48:35 -0700 (Wed, 11 Oct 2006)
Log Message:
-----------
@since tag in javadocs
Modified Paths:
--------------
trunk/spring-richclient/src/site/apt/development/conventions.apt
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/AwtExceptionHandlerAdapterHack.java
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/RegisterableExceptionHandler.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractDialogExceptionHandler.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractLoggingExceptionHandler.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractRegisterableExceptionHandler.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/DelegatingExceptionHandler.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/DelegatingExceptionHandlerDelegate.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/HibernateValidatorDialogExceptionHandler.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/LogLevel.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/MessagesDialogExceptionHandler.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/ShutdownPolicy.java
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/SimpleLoggingExceptionHandler.java
Modified: trunk/spring-richclient/src/site/apt/development/conventions.apt
===================================================================
--- trunk/spring-richclient/src/site/apt/development/conventions.apt
2006-10-10 07:58:30 UTC (rev 1502)
+++ trunk/spring-richclient/src/site/apt/development/conventions.apt
2006-10-11 07:48:35 UTC (rev 1503)
@@ -8,10 +8,15 @@
Conventions are important to keep the project consistent.
+Design
+
+ * Anything that breaks backwards compatibility should be recipe-like
documentated
+ in <<</src/site/apt/user/upgrading/upgradingTo?.?.x.apt>>>
+
Code style
TODO: none yet, this has to be thoroughly discussed on the developer list:
- Sun code conventions??? What is Spring doing?
+ Sun code conventions or eclipse build-in? With or without 120 chars per
line?
Naming Conventions
@@ -29,13 +34,20 @@
The project root pom is the (in)direct parent pom of all module poms.
Therefor dependency configuration is inherited.
- * All versions should be specified in the project root pom: never in a
child pom.
+ * All versions should be specified in the project root pom: never in a
module pom.
* All poms should only depend on their direct dependencies.
- * Dependency scope is ussually defined in the projet root pom.xml
+ * Dependency scope is ussually defined in the project root pom.xml (under
discussion)
+ * Dependencies should be marked optional (if they are optional) in the
module pom.
+
Documentation
+* Javadocs
+
+ TODO
+
+* Site documentation
+
* All apt/fml/xdoc files should be in camelCase starting with a low letter.
-
Modified:
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/AwtExceptionHandlerAdapterHack.java
===================================================================
---
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/AwtExceptionHandlerAdapterHack.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/AwtExceptionHandlerAdapterHack.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -10,6 +10,7 @@
* So this effectively only works in Sun's JDK.
*
* @author Geoffrey De Smet
+ * @since 0.3
*/
public class AwtExceptionHandlerAdapterHack {
Modified:
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/RegisterableExceptionHandler.java
===================================================================
---
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/RegisterableExceptionHandler.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/RegisterableExceptionHandler.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -1,9 +1,11 @@
package org.springframework.richclient.exceptionhandling;
/**
+ * An exception handler which can be registered (to for example the EDT and
all threads).
*
* @TODO extend Thread.UncaughtExceptionHandler when Spring-richclient is
minimum java 1.5
* @author Geoffrey De Smet
+ * @since 0.3
*/
public interface RegisterableExceptionHandler {
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractDialogExceptionHandler.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractDialogExceptionHandler.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractDialogExceptionHandler.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -13,6 +13,7 @@
/**
* Logs a throwable and shows a dialog about it to the user.
* @author Geoffrey De Smet
+ * @since 0.3
*/
public abstract class AbstractDialogExceptionHandler extends
AbstractLoggingExceptionHandler
implements InitializingBean {
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractLoggingExceptionHandler.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractLoggingExceptionHandler.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractLoggingExceptionHandler.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -11,6 +11,7 @@
* Subclasses determine how it's notified to the user.
*
* @author Geoffrey De Smet
+ * @since 0.3
*/
public abstract class AbstractLoggingExceptionHandler extends
AbstractRegisterableExceptionHandler {
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractRegisterableExceptionHandler.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractRegisterableExceptionHandler.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/AbstractRegisterableExceptionHandler.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -3,6 +3,7 @@
/**
* Uses 1.5 API.
* @author Geoffrey De Smet
+ * @since 0.3
*/
public abstract class AbstractRegisterableExceptionHandler implements
Thread.UncaughtExceptionHandler,
RegisterableExceptionHandler {
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/DelegatingExceptionHandler.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/DelegatingExceptionHandler.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/DelegatingExceptionHandler.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -17,6 +17,7 @@
* A thrown IllegalArgumentException will be handled by the (2) handler. The
(3) handler is useless.
*
* @author Geoffrey De Smet
+ * @since 0.3
*/
public class DelegatingExceptionHandler extends
AbstractRegisterableExceptionHandler implements InitializingBean {
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/DelegatingExceptionHandlerDelegate.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/DelegatingExceptionHandlerDelegate.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/DelegatingExceptionHandlerDelegate.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -7,6 +7,7 @@
* A couple of a throwable class list and the appropriate exception handler.
* Note: Also subclasses of the classes in the class list will be handled by
the exception handler.
* @author Geoffrey De Smet
+ * @since 0.3
*/
public class DelegatingExceptionHandlerDelegate {
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/HibernateValidatorDialogExceptionHandler.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/HibernateValidatorDialogExceptionHandler.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/HibernateValidatorDialogExceptionHandler.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -20,6 +20,7 @@
* Displays the validation errors to the user.
*
* @author Geoffrey De Smet
+ * @since 0.3
*/
public class HibernateValidatorDialogExceptionHandler extends
AbstractDialogExceptionHandler {
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/LogLevel.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/LogLevel.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/LogLevel.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -3,6 +3,7 @@
/**
* This enum is not available in Logging commons, but it should be.
* @author Geoffrey De Smet
+ * @since 0.3
*/
public enum LogLevel {
TRACE,
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/MessagesDialogExceptionHandler.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/MessagesDialogExceptionHandler.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/MessagesDialogExceptionHandler.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -21,6 +21,7 @@
* The exception message is passed as a parameter, but is idented and wrapped
first.
*
* @author Geoffrey De Smet
+ * @since 0.3
*/
public class MessagesDialogExceptionHandler extends
AbstractDialogExceptionHandler {
@@ -95,7 +96,7 @@
return evaluatedThrowable;
}
- public String formatMessage(String message) {
+ protected String formatMessage(String message) {
if (message == null) {
return "";
}
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/ShutdownPolicy.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/ShutdownPolicy.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/ShutdownPolicy.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -1,7 +1,11 @@
package org.springframework.richclient.exceptionhandling;
/**
+ * A paramater value to determines if the user should or should not be asked
or forced
+ * to shutdown the application when an exception occurs.
+ *
* @author Geoffrey De Smet
+ * @since 0.3
*/
public enum ShutdownPolicy {
NONE,
Modified:
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/SimpleLoggingExceptionHandler.java
===================================================================
---
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/SimpleLoggingExceptionHandler.java
2006-10-10 07:58:30 UTC (rev 1502)
+++
trunk/spring-richclient/tiger/src/main/java/org/springframework/richclient/exceptionhandling/SimpleLoggingExceptionHandler.java
2006-10-11 07:48:35 UTC (rev 1503)
@@ -5,6 +5,7 @@
* Normally it is a bad practice not to notify the user if something goes
wrong.
*
* @author Geoffrey De Smet
+ * @since 0.3
*/
public class SimpleLoggingExceptionHandler extends
AbstractLoggingExceptionHandler {
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
spring-rich-c-cvs mailing list
spring-rich-c-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/spring-rich-c-cvs
