From ef629c8e48c1e7814461a14df255d7648ec32ab6 Mon Sep 17 00:00:00 2001 From: "Eric J. Bowersox" Date: Thu, 15 Nov 2001 05:41:39 +0000 Subject: [PATCH] continuing the spread of javadoc comments --- .../venice/ValidationException.java | 41 ++++++++++++++++--- 1 file changed, 36 insertions(+), 5 deletions(-) diff --git a/src/com/silverwrist/venice/ValidationException.java b/src/com/silverwrist/venice/ValidationException.java index a99ccf7..002bb57 100644 --- a/src/com/silverwrist/venice/ValidationException.java +++ b/src/com/silverwrist/venice/ValidationException.java @@ -7,7 +7,7 @@ * WARRANTY OF ANY KIND, either express or implied. See the License for the specific * language governing rights and limitations under the License. * - * The Original Code is the Venice Web Community System. + * The Original Code is the Venice Web Communities System. * * The Initial Developer of the Original Code is Eric J. Bowersox , * for Silverwrist Design Studios. Portions created by Eric J. Bowersox are @@ -17,29 +17,60 @@ */ package com.silverwrist.venice; +/** + * An exception that is commonly thrown when a particular piece of data retrieved from the user is + * not valid. + * + * @author Eric J. Bowersox <erbo@silcom.com> + * @version X + */ public class ValidationException extends VeniceException { + /*-------------------------------------------------------------------------------- + * Constructors + *-------------------------------------------------------------------------------- + */ + + /** + * Constructs a new ValidationException. + */ public ValidationException() { super(); } // end constructor + /** + * Constructs a new ValidationException with a text message. + * + * @param msg The message to set in this exception. + */ public ValidationException(String msg) { super(msg); } // end constructor - public ValidationException(Exception e) + /** + * Constructs a new ValidationException wrapping another exception. + * + * @param inner The exception wrapped by this one. + */ + public ValidationException(Throwable inner) { - super(e); + super(inner); } // end constructor - public ValidationException(String msg, Exception e) + /** + * Constructs a new ValidationException wrapping another exception. + * + * @param msg The message to set in this exception. + * @param inner The exception wrapped by this one. + */ + public ValidationException(String msg, Throwable inner) { - super(msg,e); + super(msg,inner); } // end constructor