From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- docs/java/com/sleepycat/db/LogCursor.html | 835 +++++++++++++++--------------- 1 file changed, 405 insertions(+), 430 deletions(-) (limited to 'docs/java/com/sleepycat/db/LogCursor.html') diff --git a/docs/java/com/sleepycat/db/LogCursor.html b/docs/java/com/sleepycat/db/LogCursor.html index feec6830..0fa1a0ef 100644 --- a/docs/java/com/sleepycat/db/LogCursor.html +++ b/docs/java/com/sleepycat/db/LogCursor.html @@ -1,481 +1,456 @@ - - - - - -LogCursor (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-

- -com.sleepycat.db -
-Class LogCursor

-
-java.lang.Object
-  extended by com.sleepycat.db.LogCursor
-
-
-
-
public class LogCursor
extends Object
- - -

-The LogCursor object is the handle for a cursor into the log files, +

+
com.sleepycat.db
+

Class LogCursor

+
+
+ +
+
    +
  • +
    +
    +
    public class LogCursor
+extends java.lang.Object
    +
    The LogCursor object is the handle for a cursor into the log files, supporting sequential access to the records stored in log files.

    -The handle is not free-threaded. Once the LogCursor.close +The handle is not free-threaded. Once the LogCursor.close method is called, the handle may not be accessed again, regardless of -that method's success or failure. -

    - -

    -

    - -

    - +that method's success or failure.

    +
    • +
+
+
+ +
+
+
    +
  • - - - - - - -
    -Method Detail
    - -

    -close

    -
    -public void close()
-           throws DatabaseException
    -
    -
    Discard the log cursor. After close() has been called, regardless of its - return, the cursor handle may not be used again. -

    -

    - -
    Throws: -
    DatabaseException
    -
    -
    -
    - -

    -getCurrent

    -
    -public OperationStatus getCurrent(LogSequenceNumber lsn,
-                                  DatabaseEntry data)
-                           throws DatabaseException
    -
    -
    Return the LogSequenceNumber and log record to which the log cursor +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws DatabaseException
        +
        Discard the log cursor. After close() has been called, regardless of its + return, the cursor handle may not be used again.
        +
        Throws:
        +
        DatabaseException
        +
        • +
      + + + +
        +
      • +

        getCurrent

        +
        public OperationStatus getCurrent(LogSequenceNumber lsn,
+                         DatabaseEntry data)
+                           throws DatabaseException
        +
        Return the LogSequenceNumber and log record to which the log cursor currently refers. -

        -

        -

        -
        Parameters:
        lsn - The returned LogSequenceNumber. -

        data - The returned log record. The data field is set to the record +

        +
        Parameters:
        lsn - The returned LogSequenceNumber. +

        data - The returned log record. The data field is set to the record retrieved, and the size field indicates the number of bytes in the record. -

        -

        Returns:
        The status of the operation. -

        -

        -

        Throws: -
        DatabaseException - if a failure occurs.
        -
    -
    -
    - -

    -getNext

    -
    -public OperationStatus getNext(LogSequenceNumber lsn,
-                               DatabaseEntry data)
-                        throws DatabaseException
    -
    -
    Return the next LogSequenceNumber and log record. +

    +
    Returns:
    The status of the operation. +

    +

    +
    Throws:
    +
    DatabaseException - if a failure occurs.
    +
    • +
+ + + +
    +
  • +

    getNext

    +
    public OperationStatus getNext(LogSequenceNumber lsn,
+                      DatabaseEntry data)
+                        throws DatabaseException
    +
    Return the next LogSequenceNumber and log record.

    The current log position is advanced to the next record in the log, and its LogSequenceNumber and data are returned. If the cursor has not been initialized, the first available log record in the log will be returned. -

    -

    -

    -
    Parameters:
    lsn - The returned LogSequenceNumber. -

    data - The returned log record. -

    -

    Returns:
    The status of the operation; a return of NOTFOUND indicates the last +

    +
    Parameters:
    lsn - The returned LogSequenceNumber. +

    data - The returned log record. +

    +
    Returns:
    The status of the operation; a return of NOTFOUND indicates the last log record has already been returned or the log is empty.

    -

    -

    Throws: -
    DatabaseException - if a failure occurs.
    - - -
    - -

    -getFirst

    -
    -public OperationStatus getFirst(LogSequenceNumber lsn,
-                                DatabaseEntry data)
-                         throws DatabaseException
    -
    -
    Return the first LogSequenceNumber and log record. +

    +
    Throws:
    +
    DatabaseException - if a failure occurs.
    +
    • +
+ + + +
    +
  • +

    getFirst

    +
    public OperationStatus getFirst(LogSequenceNumber lsn,
+                       DatabaseEntry data)
+                         throws DatabaseException
    +
    Return the first LogSequenceNumber and log record.

    The current log position is set to the first record in the log, and its LogSequenceNumber and data are returned. -

    -

    -

    -
    Parameters:
    lsn - The returned LogSequenceNumber. -

    data - The returned log record. -

    -

    Returns:
    The status of the operation; a return of NOTFOUND indicates the log +

    +
    Parameters:
    lsn - The returned LogSequenceNumber. +

    data - The returned log record. +

    +
    Returns:
    The status of the operation; a return of NOTFOUND indicates the log is empty.

    -

    -

    Throws: -
    DatabaseException - if a failure occurs.
    - - -
    - -

    -getLast

    -
    -public OperationStatus getLast(LogSequenceNumber lsn,
-                               DatabaseEntry data)
-                        throws DatabaseException
    -
    -
    Return the last LogSequenceNumber and log record. +

    +
    Throws:
    +
    DatabaseException - if a failure occurs.
    +
    • +
+ + + +
    +
  • +

    getLast

    +
    public OperationStatus getLast(LogSequenceNumber lsn,
+                      DatabaseEntry data)
+                        throws DatabaseException
    +
    Return the last LogSequenceNumber and log record.

    The current log position is set to the last record in the log, and its LogSequenceNumber and data are returned. -

    -

    -

    -
    Parameters:
    lsn - The returned LogSequenceNumber. -

    data - The returned log record. -

    -

    Returns:
    The status of the operation; a return of NOTFOUND indicates the log +

    +
    Parameters:
    lsn - The returned LogSequenceNumber. +

    data - The returned log record. +

    +
    Returns:
    The status of the operation; a return of NOTFOUND indicates the log is empty.

    -

    -

    Throws: -
    DatabaseException - if a failure occurs.
    - - -
    - -

    -getPrev

    -
    -public OperationStatus getPrev(LogSequenceNumber lsn,
-                               DatabaseEntry data)
-                        throws DatabaseException
    -
    -
    Return the previous LogSequenceNumber and log record. +

    +
    Throws:
    +
    DatabaseException - if a failure occurs.
    +
    • +
+ + + +
    +
  • +

    getPrev

    +
    public OperationStatus getPrev(LogSequenceNumber lsn,
+                      DatabaseEntry data)
+                        throws DatabaseException
    +
    Return the previous LogSequenceNumber and log record.

    The current log position is advanced to the previous record in the log, and its LogSequenceNumber and data are returned. If the cursor has not been initialized, the last available log record in the log will be returned. -

    -

    -

    -
    Parameters:
    lsn - The returned LogSequenceNumber. -

    data - The returned log record. -

    -

    Returns:
    The status of the operation; a return of NOTFOUND indicates the first +

    +
    Parameters:
    lsn - The returned LogSequenceNumber. +

    data - The returned log record. +

    +
    Returns:
    The status of the operation; a return of NOTFOUND indicates the first log record has already been returned or the log is empty.

    -

    -

    Throws: -
    DatabaseException - if a failure occurs.
    - - -
    - -

    -set

    -
    -public OperationStatus set(LogSequenceNumber lsn,
-                           DatabaseEntry data)
-                    throws DatabaseException
    -
    -
    Return a specific log record. +

    +
    Throws:
    +
    DatabaseException - if a failure occurs.
    +
    • +
+ + + +
    +
  • +

    set

    +
    public OperationStatus set(LogSequenceNumber lsn,
+                  DatabaseEntry data)
+                    throws DatabaseException
    +
    Return a specific log record.

    The current log position is set to the specified record in the log, and its data is returned. -

    -

    -

    -
    Parameters:
    lsn - The specified LogSequenceNumber. -

    data - The returned log record. -

    -

    Returns:
    The status of the operation. -

    -

    -

    Throws: -
    DatabaseException - if a failure occurs.
    -
    - -
    - -

    -version

    -
    -public int version()
-            throws DatabaseException
    -
    -
    Get the log file version. -

    -

    -

    - -
    Returns:
    The log file version. -

    -

    -

    Throws: -
    DatabaseException - if a failure occurs.
    -
    -
    +

    +
    Parameters:
    lsn - The specified LogSequenceNumber. +

    data - The returned log record. +

    +
    Returns:
    The status of the operation. +

    +

    +
    Throws:
    +
    DatabaseException - if a failure occurs.
    +
    • +
+ + + +
    +
  • +

    version

    +
    public int version()
+            throws DatabaseException
    +
    Get the log file version. +

    +
    Returns:
    The log file version. +

    +

    +
    Throws:
    +
    DatabaseException - if a failure occurs.
    +
    • +
+ + + + +
+
-
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved. - - +

Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.

+ + -- cgit v1.2.1