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/DatabaseStream.html | 425 +++++++++++++++++++++++++ 1 file changed, 425 insertions(+) create mode 100644 docs/java/com/sleepycat/db/DatabaseStream.html (limited to 'docs/java/com/sleepycat/db/DatabaseStream.html') diff --git a/docs/java/com/sleepycat/db/DatabaseStream.html b/docs/java/com/sleepycat/db/DatabaseStream.html new file mode 100644 index 00000000..bcb4661d --- /dev/null +++ b/docs/java/com/sleepycat/db/DatabaseStream.html @@ -0,0 +1,425 @@ + + + + + +DatabaseStream (Oracle - Berkeley DB Java API) + + + + + + + +
+ + + + + +
Berkeley DB
version 6.1.23
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.sleepycat.db
+

Class DatabaseStream

+
+
+ +
+
    +
  • +
    +
    +
    public class DatabaseStream
+extends java.lang.Object
    +
    A database stream. The database stream is used to access the blob. +

    +Once the database stream close method has been called, the handle may not +be accessed again. +

    +To obtain a database stream with default attributes: +

    +    DatabaseStream dbs = myCursor.openDatabaseStream(null);
+
    +To customize the attributes of a database stream, +use a DatabaseStreamConfig object. +
    +    DatabaseStreamConfig config = new DatabaseStreamConfig();
+    config.setReadOnly(true);
+    DatabaseStream dbs = myCursor.openDatabaseStream(config);
+
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Discard the database stream.
      +
      DatabaseStreamConfiggetConfig() +
      Return this database stream configuration.
      +
      CursorgetCursor() +
      Return the Cursor handle associated + with this database stream.
      +
      OperationStatusread(DatabaseEntry data, + long offset, + int size) +
      Read from the blob accessed by this database stream.
      +
      longsize() +
      Return the size in bytes of the blob accessed by the database stream.
      +
      OperationStatuswrite(DatabaseEntry data, + long offset) +
      Write to the blob accessed by the database stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws DatabaseException
        +
        Discard the database stream. +

        + After the close method has been called, you cannot use the database stream + handle again. +

        + It is recommended to always close all database stream handles immediately + after their use to release resources. +

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

        getConfig

        +
        public DatabaseStreamConfig getConfig()
        +
        Return this database stream configuration. +

        +
        Returns:
        This database stream configuration. +

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

        getCursor

        +
        public Cursor getCursor()
        +
        Return the Cursor handle associated + with this database stream. +

        +
        Returns:
        The cursor handle associated with this database stream.
        +
        • +
      + + + +
        +
      • +

        read

        +
        public OperationStatus read(DatabaseEntry data,
+                   long offset,
+                   int size)
+                     throws DatabaseException,
+                            java.lang.IllegalArgumentException
        +
        Read from the blob accessed by this database stream. +

        +
        Parameters:
        data - the data read from the blob + returned as output. Its byte array does not need to be initialized by the + caller. +

        offset - the position in bytes in the blob where the reading starts. +

        size - the number of bytes to read. +

        +
        Returns:
        OperationStatus.SUCCESS + if the operation succeeds. +

        +
        Throws:
        +
        java.lang.IllegalArgumentException - if a failure occurs. +

        +
        java.lang.IllegalArgumentException - if the operation fails. +

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

        size

        +
        public long size()
+          throws DatabaseException
        +
        Return the size in bytes of the blob accessed by the database stream. +

        +
        Returns:
        The size in bytes of the blob accessed by the database stream. +

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

        write

        +
        public OperationStatus write(DatabaseEntry data,
+                    long offset)
+                      throws DatabaseException,
+                             java.lang.IllegalArgumentException
        +
        Write to the blob accessed by the database stream. +

        +
        Parameters:
        data - the data DatabaseEntry + to write into the blob. +

        offset - the position in bytes in the blob where the writing starts. +

        +
        Returns:
        OperationStatus.SUCCESS + if the operation succeeds. +

        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the operation fails. +

        +
        DatabaseException - if a failure occurs.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
Berkeley DB
version 6.1.23
+
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.1