Mailing-List: contact derby-commits-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Derby Development" <derby-dev@db.apache.org>
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r597110 -
 /db/derby/code/trunk/java/engine/org/apache/derby/impl/load/ImportLobFile.java
Date: Wed, 21 Nov 2007 15:19:49 -0000
To: derby-commits@db.apache.org
From: kristwaa@apache.org
Message-Id: <20071121151949.CF7B81A9832@eris.apache.org>

Author: kristwaa
Date: Wed Nov 21 07:19:49 2007
New Revision: 597110

URL: http://svn.apache.org/viewvc?rev=597110&view=rev
Log:
Converted a batch of comments into JavaDoc by adding another star. Made minor changes to text/comments.

Modified:
    db/derby/code/trunk/java/engine/org/apache/derby/impl/load/ImportLobFile.java

Modified: db/derby/code/trunk/java/engine/org/apache/derby/impl/load/ImportLobFile.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/impl/load/ImportLobFile.java?rev=597110&r1=597109&r2=597110&view=diff
==============================================================================
--- db/derby/code/trunk/java/engine/org/apache/derby/impl/load/ImportLobFile.java (original)
+++ db/derby/code/trunk/java/engine/org/apache/derby/impl/load/ImportLobFile.java Wed Nov 21 07:19:49 2007
@@ -48,9 +48,9 @@
     private String dataCodeset; 
     
 
-    /*
+    /**
      * Create a ImportLobFile object.
-     * @param lobFile  the file which has the LOB Data.
+     * @param lobFile the file which has the LOB Data.
      * @param dataCodeset the code set to use char data in the file.
      */
     ImportLobFile(File lobFile, String dataCodeset) throws Exception {
@@ -59,10 +59,10 @@
     }
 
 
-    /* 
+    /**
      * Open the lob file and setup the stream required to read the data.
      * @param lobFile the file that contains lob data.
-     * @exception  Exception  if an error occurs.     
+     * @exception Exception if an error occurs.     
      */
     private void openLobFile(final File lobFile) 
         throws Exception 
@@ -88,11 +88,11 @@
                       lobFile.getPath()));
         } 
         
-        // set up stream to read from input file, starting from 
+        // Set up stream to read from input file, starting from 
         // any offset in the file. Users can specify columns in 
         // any order or skip some during import. So it is 
-        // is required  for this stream have ability to read from 
-        // any offset in the file. 
+        // required for this stream to have the ability to read
+        // from any offset in the file. 
 
         lobInputStream = new ImportFileInputStream(lobRaf);
 
@@ -105,10 +105,10 @@
     }
 
 
-    /*
+    /**
      * Returns a stream that points to the lob data from file at the 
-     * given <code> offset </code>.
-     * at the specified offset. 
+     * given <code>offset</code>.
+     *
      * @param offset  byte offset of the column data in the file. 
      * @param length  length of the the data.
      * @exception  IOException  if any I/O error occurs.     
@@ -122,8 +122,8 @@
     }
 
 
-    /* 
-     * Returns the clob data at the given location as String. 
+    /**
+     * Returns the clob data at the given location as <code>String</code>. 
      * @param offset  byte offset of the column data in the file. 
      * @param length  length of the the data.
      * @exception  IOException  on any I/O error.     
@@ -152,9 +152,9 @@
     }
 
 
-    /* 
+    /** 
      * Returns a stream that points to the clob data from file at the 
-     * given <code> offset </code>.
+     * given <code>offset</code>.
      * @param offset  byte offset of the column data in the file. 
      * @param length  length of the the data in bytes.
      * @exception  IOException  on any I/O error.     
@@ -176,7 +176,7 @@
         return lobReader;
     }
 
-    /*
+    /**
      * Returns the clob data length in characters at the give location. 
      * @param offset  byte offset of the column data in the file. 
      * @param length  length of the the data in bytes.
@@ -206,8 +206,8 @@
         return lengthInChars;
     }
 
-    /* 
-     * close all the resources realate to the lob file.
+    /**
+     * Close all the resources realated to the lob file.
      */
     public void close() throws IOException {
 
@@ -235,9 +235,8 @@
  * any offset in the file. This stream operates on top of a 
  * RandomAccessFile object. This class overrides InputStream methods to 
  * read from the given RandomAccessFile and provides an addtional method
- * <code> seek(..) </code> to postion the stream at offset in the file. 
+ * <code>seek(..)</code> to position the stream at offset in the file. 
  */
-
 class ImportFileInputStream extends InputStream 
 {
 
@@ -246,8 +245,8 @@
     private long fileLength = 0;
 
     /**
-     * Create a <code> ImportFileInputStreamm object  </code> for 
-     * the given  file.  
+     * Create a <code>ImportFileInputStream</code> object for 
+     * the given file.  
      * @param raf  file the stream reads from. 
      * @exception  IOException  if any I/O error occurs.
      */
@@ -258,8 +257,8 @@
         this.fileLength = raf.length();
     }
 
-    /*
-     * sets the file offset at which the next read will occur. 
+    /**
+     * Sets the file offset at which the next read will occur. 
      * @param offset byte offset in the file.
      * @exception  IOException  if an I/O error occurs.     
      */
@@ -269,8 +268,8 @@
     }
 
 
-    /** overide following input stream methods to read data from the 
-     *  from the current postion of the file. 
+    /* Override the following InputStream-methods to
+     * read data from the current postion of the file.
      */