db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mi...@apache.org
Subject svn commit: r165169 - in /incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store: access/heap/ raw/log/ raw/xact/
Date Thu, 28 Apr 2005 17:48:42 GMT
Author: mikem
Date: Thu Apr 28 10:48:40 2005
New Revision: 165169

URL: http://svn.apache.org/viewcvs?rev=165169&view=rev
Log:
more store javadoc fixes.


Modified:
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/Heap.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapController.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapCostController.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapPostCommit.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/ChecksumOperation.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/FileLogger.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogAccessFile.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogToFile.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/StreamLogScan.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/xact/XactFactory.java

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/Heap.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/Heap.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/Heap.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/Heap.java
Thu Apr 28 10:48:40 2005
@@ -162,7 +162,7 @@
     /* Constructors for This class: */
 
     /**
-     * Zero arg. constructor for Monitor to create empty object.
+     * Zero arg constructor for Monitor to create empty object.
      **/
     public Heap()
     {
@@ -982,7 +982,7 @@
      */
 
     /**
-     * return the "Conglomerate"
+     * return the "Conglomerate".
      * <p>
      * For heap just return "this", which both implements Conglomerate and
      * StaticCompiledOpenConglomInfo.

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapController.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapController.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapController.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapController.java
Thu Apr 28 10:48:40 2005
@@ -687,10 +687,10 @@
      *
 	 * @return true if lock was granted, only can be false if wait was false.
      *
-	 * @param loc       The "RowLocation" which describes the exact row to lock.
-     * @param forUpdate Lock the record for read or write.
-     * @param forInsert is row Lock for insert?
-     * @param wait      Should the lock call wait to be granted?
+     * @param page_num          Page number of row to lock.
+     * @param record_id         Record id of row on page_num to lock.
+     * @param lock_operation    Desc of what to lock for, ie. update, insert ...
+     * @param wait              Should the lock call wait to be granted?
      *
 	 * @exception  StandardException  Standard exception policy.
      **/

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapCostController.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapCostController.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapCostController.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapCostController.java
Thu Apr 28 10:48:40 2005
@@ -289,7 +289,7 @@
      *                        conglomerate.  The startKeyValue must only
      *                        reference columns included in the scanColumnList.
      *
-	 * @param startSearchOperation 
+	 * @param startSearchOperator 
      *                        an operator which defines how the startKeyValue
      *                        is to be searched for.  If startSearchOperation 
      *                        is ScanController.GE, the scan starts on the 
@@ -308,7 +308,7 @@
      *                        stopKeyValue must only reference columns included
      *                        in the scanColumnList.
      *
-	 * @param stopSearchOperation
+	 * @param stopSearchOperator
      *                        an operator which defines how the stopKeyValue
      *                        is used to determine the scan stopping position. 
      *                        If stopSearchOperation is ScanController.GE, the
@@ -343,7 +343,7 @@
     long                    row_count,
     int                     group_size,
     boolean                 forUpdate,
-    FormatableBitSet                 scanColumnList,
+    FormatableBitSet        scanColumnList,
     DataValueDescriptor[]   template,
     DataValueDescriptor[]   startKeyValue,
     int                     startSearchOperator,

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapPostCommit.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapPostCommit.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapPostCommit.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/heap/HeapPostCommit.java
Thu Apr 28 10:48:40 2005
@@ -112,8 +112,8 @@
      * This routine will latch the page and hold the latch due to interface
      * requirement from Page.purgeAtSlot.
      *
-     * @param open_btree The btree already opened.
-     * @param pageno The page number of the page to look for committed deletes.
+     * @param heap_control  The heap, already opened.
+     * @param pageno        number of page to look for committed deletes.
      *
      * @see Page#purgeAtSlot
      * @exception  StandardException  Standard exception policy.

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/ChecksumOperation.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/ChecksumOperation.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/ChecksumOperation.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/ChecksumOperation.java
Thu Apr 28 10:48:40 2005
@@ -177,7 +177,6 @@
 
 		Checksum has no optional data to write out
 
-		@param out Where and how to write to optional data.
 		
 	*/
 	public ByteArray getPreparedLog()

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/FileLogger.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/FileLogger.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/FileLogger.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/FileLogger.java
Thu Apr 28 10:48:40 2005
@@ -441,7 +441,6 @@
 		@param undoInstant the log instant of the operation that is to be
 		rolled back
 		@param in optional data input for the compenastion doMe method
-		@param dataLength optional data length
 
 		@return the instant in the log that can be used to identify the log
 		record
@@ -1104,12 +1103,7 @@
 
 		<P> MT - caller provides synchronization
 
-		@param logData          - a scratch area to put the log record in
-		@param rawStoreFactory  - the raw store factory
 		@param transFactory     - the transaction factory
-		@param redoStart        - if > 0, a checkpoint was found.
-		                          Start the log scan from here to rebuild 
-                                  transaction table.
 		@param redoLWM          - if checkpoint seen, starting from this point
                                   on, apply redo if necessary
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogAccessFile.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogAccessFile.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogAccessFile.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogAccessFile.java
Thu Apr 28 10:48:40 2005
@@ -735,9 +735,11 @@
 
 	/**
 	 * reserve the space for the checksum log record in the log file. 
-	 * @param  the length of the log record that is going to be written
-	 * @param  logFileNumber current log file number 
+     *
+	 * @param  length           the length of the log record to be written
+	 * @param  logFileNumber    current log file number 
 	 * @param  currentPosition  current position in the log file. 
+     *
 	 * @return the space that is needed to write a checksum log record.
 	 */
 	protected long reserveSpaceForChecksum(int length, long logFileNumber, long currentPosition
)

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogToFile.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogToFile.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogToFile.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/LogToFile.java
Thu Apr 28 10:48:40 2005
@@ -1639,7 +1639,6 @@
 		<P>MT - not needed, no global variables used
 
 		@param logFileName the name of the log file
-		@param version the log version 
 		@param number the log file number
 		@return true if the log file is of the current version and of the
 		correct format
@@ -1711,7 +1710,7 @@
 
 		<P>MT - synchornization provided by caller
 
-		@param newLog the new log file to be initialized
+		@param newlog the new log file to be initialized
 		@param number the log file number
 		@param prevLogRecordEndInstant the end position of the  previous log record
 
@@ -1975,7 +1974,7 @@
 
 		<P>MT - not needed, wrapper method
 
-		@param where flush log up to here
+		@param wherePosition flush log up to here
 
 		@exception IOException Failed to flush to the log
 	*/

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/StreamLogScan.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/StreamLogScan.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/StreamLogScan.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/log/StreamLogScan.java
Thu Apr 28 10:48:40 2005
@@ -46,14 +46,15 @@
 		transaction Id and a group mask.  If provided, only log record that
 		matches the transaction Id and the group mask is returned.
 
-		@param input the ArrayInputStream to put the log record
-		@param logicalInput the logical input stream that is attached to input
-		@param tranId if non-null, only log record that equals tranId will be
-		returned.  If null, log records are not filtered on transaction Id. 
-		@param groupmask, if non-zero, only log record whose Loggable's group
-		value is included in the groupmask is returned.  groupmask can be a bit
-		wise OR of many Loggable groups.  If zero, log records are not filtered
-		on the Loggable's group.
+		@param input        the ArrayInputStream to put the log record
+		@param tranId       if non-null, only log record that equals tranId 
+                            will be returned.  If null, log records are not 
+                            filtered on transaction Id. 
+		@param groupmask    if non-zero, only log record whose Loggable's group
+                            value is included in the groupmask is returned.  
+                            groupmask can be a bit wise OR of many Loggable 
+                            groups.  If zero, log records are not filtered on 
+                            the Loggable's group.
 
 		@return an object that represents the log record, return null if the
 		scan has completed. 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/xact/XactFactory.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/xact/XactFactory.java?rev=165169&r1=165168&r2=165169&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/xact/XactFactory.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/xact/XactFactory.java
Thu Apr 28 10:48:40 2005
@@ -238,8 +238,6 @@
      * @param compatibilitySpace 
      *               if null, use the transaction being created, else if 
      *               non-null use this compatibilitySpace.
-     * @param cm     true if transaction should be waited for and halted 
-     *               during refresh.
      *
 	 * @exception  StandardException  Standard exception policy.
      **/



Mime
View raw message