commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@apache.org
Subject svn commit: r209161 - /jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java
Date Tue, 05 Jul 2005 01:01:05 GMT
Author: dion
Date: Mon Jul  4 18:01:03 2005
New Revision: 209161

URL: http://svn.apache.org/viewcvs?rev=209161&view=rev
Log:
Add serialVersionUID
Fix Javadoc

Modified:
    jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java

Modified: jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java?rev=209161&r1=209160&r2=209161&view=diff
==============================================================================
--- jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java
(original)
+++ jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java
Mon Jul  4 18:01:03 2005
@@ -23,15 +23,22 @@
  */
 public class EmailException extends NestableException
 {
-    /** */
+    /** serialization version */
+    static final long serialVersionUID = 5550674499282474616L;
+    
+    /**
+     * Create a new EmailException with no message and no cause.
+     * Note: This constructor should only be used as a last resort. Please 
+     *      provide at least a message.
+     */
     public EmailException()
     {
         super();
     }
 
     /**
-     *
-     * @param msg msg
+     * Create a new EmailException with a message but no other cause.
+     * @param msg the reason for this exception.
      */
     public EmailException(String msg)
     {
@@ -39,9 +46,9 @@
     }
 
     /**
-     *
-     * @param msg msg
-     * @param cause cause
+     * Create a new EmailException with a message and a cause.
+     * @param msg the reason for this exception.
+     * @param cause the contributing Throwable (e.g. some other Exception)
      */
     public EmailException(String msg, Throwable cause)
     {
@@ -49,8 +56,8 @@
     }
 
     /**
-     *
-     * @param cause cause
+     * Create a new EmailException with a cause but no message.
+     * @param cause the contributing Throwable (e.g. some other Exception)
      */
     public EmailException(Throwable cause)
     {



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message