svn commit: r422882 - /db/derby/code/trunk/java/drda/org/apache/derby/impl/drda/DRDAProtocolExceptionInfo.java

[ka...@apache.org]

Author: kahatlen
Date: Mon Jul 17 14:28:14 2006
New Revision: 422882

URL: http://svn.apache.org/viewvc?rev=422882&view=rev
Log:
Adding more detailed comments to DRDAProtocolExceptionInfo.java. Patch
contributed by Sunitha Kambhampati.

Modified:
    db/derby/code/trunk/java/drda/org/apache/derby/impl/drda/DRDAProtocolExceptionInfo.java

Modified: db/derby/code/trunk/java/drda/org/apache/derby/impl/drda/DRDAProtocolExceptionInfo.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/drda/org/apache/derby/impl/drda/DRDAProtocolExceptionInfo.java?rev=422882&r1=422881&r2=422882&view=diff
==============================================================================
--- db/derby/code/trunk/java/drda/org/apache/derby/impl/drda/DRDAProtocolExceptionInfo.java (original)
+++ db/derby/code/trunk/java/drda/org/apache/derby/impl/drda/DRDAProtocolExceptionInfo.java Mon Jul 17 14:28:14 2006
@@ -26,13 +26,27 @@
       Holds static information about the protocol error
       to put in the Hash Table
     */
-    // The Codepoint of the error (e.g CodePoint.SYTNAXRM)
+    
+    /**
+     * errorCodePoint specifies the code point of the error reply message, (e.g.
+     * CodePoint.SYNTAXRM) whereas errCdCodePoint specifies the code point of an
+     * extra required field in that reply message. Most error reply messages
+     * have one or two required fields that are quite common, like SVRCOD
+     * (severity code) or RDBNAM (database name). Some error reply messages
+     * additionally have required fields that are specific to them.
+     * errCdCodePoint is used to specify these. For instance, SYNTAXRM has a
+     * required field called SYNERRCD, and PRCCNVRM has a required field called
+     * PRCCNVCD.
+     */
     protected int errorCodePoint;	   
     
     // Severity Code
     protected int svrcod;
     
-    // The CodePoint describing the errCD (e.g. CodePint.SYNERRCD)
+    /**
+     * The CodePoint describing the error condition for the errorCodePoint.
+     * (e.g. CodePoint.SYNERRCD, when errorCodePoint is CodePoint.SYNTAXRM)
+     */
     protected int errCdCodePoint ;
     
     // Sends an originating Codepoint