From f8a74f39acbc5004faefcd352ecc0608eb6b52aa Mon Sep 17 00:00:00 2001 From: dsyer Date: Wed, 19 Mar 2008 13:44:05 +0000 Subject: [PATCH] RESOLVED - issue BATCH-489: undocumented JobExecutionException --- .../batch/core/JobExecutionException.java | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/JobExecutionException.java b/spring-batch-core/src/main/java/org/springframework/batch/core/JobExecutionException.java index b2c6fe776..5e87b6304 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/JobExecutionException.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/JobExecutionException.java @@ -16,15 +16,31 @@ package org.springframework.batch.core; /** + * Root of exception hierarchy for checked exceptions in job and step execution. + * Clients of the {@link Job} should expect to have to catch and deal with these + * exceptions because they signal a user error, or an inconsistent state between + * the user's instructions and the data. + * * @author Dave Syer - * + * */ public class JobExecutionException extends Exception { + /** + * Construct a {@link JobExecutionException} with a generic message. + * @param msg the message + */ public JobExecutionException(String msg) { super(msg); } + /** + * Construct a {@link JobExecutionException} with a generic message and a + * cause. + * + * @param msg the message + * @param cause the cause of the exception + */ public JobExecutionException(String msg, Throwable cause) { super(msg, cause); }