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/bind/tuple/TupleBase.html | 837 +++++++++++----------- 1 file changed, 409 insertions(+), 428 deletions(-) (limited to 'docs/java/com/sleepycat/bind/tuple/TupleBase.html') diff --git a/docs/java/com/sleepycat/bind/tuple/TupleBase.html b/docs/java/com/sleepycat/bind/tuple/TupleBase.html index a876d5bc..b28744db 100644 --- a/docs/java/com/sleepycat/bind/tuple/TupleBase.html +++ b/docs/java/com/sleepycat/bind/tuple/TupleBase.html @@ -1,460 +1,441 @@ - - - - - -TupleBase (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.bind.tuple -
-Class TupleBase<E>

-
-java.lang.Object
-  extended by com.sleepycat.bind.tuple.TupleBase<E>
-
-
-
Direct Known Subclasses:
TupleBinding, TupleSerialBinding, TupleSerialKeyCreator, TupleTupleBinding, TupleTupleKeyCreator
-
-
-
-
public class TupleBase<E>
extends Object
- - -

-A base class for tuple bindings and tuple key creators that provides control +

+
com.sleepycat.bind.tuple
+

Class TupleBase<E>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    TupleBinding, TupleSerialBinding, TupleSerialKeyCreator, TupleTupleBinding, TupleTupleKeyCreator
    +
    +
    +
    +
    public class TupleBase<E>
+extends java.lang.Object
    +
    A base class for tuple bindings and tuple key creators that provides control over the allocation of the output buffer. -

    Tuple bindings and key creators append data to a TupleOutput - instance, which is also a FastOutputStream +

    Tuple bindings and key creators append data to a TupleOutput + instance, which is also a FastOutputStream instance. This object has a byte array buffer that is resized when it is full. The reallocation of this buffer can be a performance factor for - some applications using large objects. To manage this issue, the setTupleBufferSize(int) method may be used to control the initial size of the - buffer, and the getTupleOutput(E) method may be overridden by - subclasses to take over creation of the TupleOutput object.

    -

    - -

    -

    - -

    - + some applications using large objects. To manage this issue, the setTupleBufferSize(int) method may be used to control the initial size of the + buffer, and the getTupleOutput(E) method may be overridden by + subclasses to take over creation of the TupleOutput object.

    +
    • +
+
+
+ +
+
+
    +
  • - - - - - - -
    -Constructor Detail
    - -

    -TupleBase

    -
    -public TupleBase()
    -
    -
    Initializes the initial output buffer size to zero. - -

    Unless setTupleBufferSize(int) is called, the default FastOutputStream.DEFAULT_INIT_SIZE size will be - used.

    -

    -

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

    -setTupleBufferSize

    -
    -public void setTupleBufferSize(int byteSize)
    -
    -
    Sets the initial byte size of the output buffer that is allocated by the - default implementation of getTupleOutput(E). - -

    If this property is zero (the default), the default FastOutputStream.DEFAULT_INIT_SIZE size is used.

    -

    -

    -
    Parameters:
    byteSize - the initial byte size of the output buffer, or zero to - use the default size.
    -
    -
    -
    - -

    -getTupleBufferSize

    -
    -public int getTupleBufferSize()
    -
    -
    Returns the initial byte size of the output buffer. -

    -

    - -
    Returns:
    the initial byte size of the output buffer.
    See Also:
    setTupleBufferSize(int)
    -
    -
    -
    - -

    -getTupleOutput

    -
    -protected TupleOutput getTupleOutput(E object)
    -
    -
    Returns an empty TupleOutput instance that will be used by the tuple +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setTupleBufferSize

        +
        public void setTupleBufferSize(int byteSize)
        +
        Sets the initial byte size of the output buffer that is allocated by the + default implementation of getTupleOutput(E). + +

        If this property is zero (the default), the default FastOutputStream.DEFAULT_INIT_SIZE size is used.

        +
        Parameters:
        byteSize - the initial byte size of the output buffer, or zero to + use the default size.
        +
        • +
      + + + +
        +
      • +

        getTupleBufferSize

        +
        public int getTupleBufferSize()
        +
        Returns the initial byte size of the output buffer.
        +
        Returns:
        the initial byte size of the output buffer.
        See Also:
        setTupleBufferSize(int)
        +
        • +
      + + + + + +
        +
      • +

        getTupleOutput

        +
        protected TupleOutput getTupleOutput(E object)
        +
        Returns an empty TupleOutput instance that will be used by the tuple binding or key creator.

        The default implementation of this method creates a new TupleOutput - with an initial buffer size that can be changed using the setTupleBufferSize(int) method.

        + with an initial buffer size that can be changed using the setTupleBufferSize(int) method.

        This method may be overridden to return a TupleOutput instance. For example, an instance per thread could be created and returned by this method. If a TupleOutput instance is reused, be sure to call its - FastOutputStream.reset() method before each - use.

        -

        -

        -
        Parameters:
        object - is the object to be written to the tuple output, and may - be used by subclasses to determine the size of the output buffer. -
        Returns:
        an empty TupleOutput instance.
        See Also:
        setTupleBufferSize(int)
        -
        -
    -
    - -

    -outputToEntry

    -
    -public static void outputToEntry(TupleOutput output,
-                                 DatabaseEntry entry)
    -
    -
    Utility method to set the data in a entry buffer to the data in a tuple - output object. -

    -

    -
    Parameters:
    output - is the source tuple output object.
    entry - is the destination entry buffer.
    -
    -
    -
    - -

    -inputToEntry

    -
    -public static void inputToEntry(TupleInput input,
-                                DatabaseEntry entry)
    -
    -
    Utility method to set the data in a entry buffer to the data in a tuple - input object. -

    -

    -
    Parameters:
    input - is the source tuple input object.
    entry - is the destination entry buffer.
    -
    -
    -
    - -

    -entryToInput

    -
    -public static TupleInput entryToInput(DatabaseEntry entry)
    -
    -
    Utility method to create a new tuple input object for reading the data + FastOutputStream.reset() method before each + use.

+
Parameters:
object - is the object to be written to the tuple output, and may + be used by subclasses to determine the size of the output buffer.
+
Returns:
an empty TupleOutput instance.
See Also:
setTupleBufferSize(int)
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
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