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/TupleInput.html | 2252 +++++++++----------- 1 file changed, 1052 insertions(+), 1200 deletions(-) (limited to 'docs/java/com/sleepycat/bind/tuple/TupleInput.html') diff --git a/docs/java/com/sleepycat/bind/tuple/TupleInput.html b/docs/java/com/sleepycat/bind/tuple/TupleInput.html index 866f8fa8..a22b19be 100644 --- a/docs/java/com/sleepycat/bind/tuple/TupleInput.html +++ b/docs/java/com/sleepycat/bind/tuple/TupleInput.html @@ -1,1239 +1,1091 @@ - - - - - -TupleInput (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 TupleInput

-
-java.lang.Object
-  extended by java.io.InputStream
-      extended by com.sleepycat.util.FastInputStream
-          extended by com.sleepycat.bind.tuple.TupleInput
-
-
-
All Implemented Interfaces:
Closeable
-
-
-
-
public class TupleInput
extends FastInputStream
- - -

-An InputStream with DataInput-like methods for +

+
com.sleepycat.bind.tuple
+

Class TupleInput

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class TupleInput
+extends FastInputStream
    +
    An InputStream with DataInput-like methods for reading tuple fields. It is used by TupleBinding.

    This class has many methods that have the same signatures as methods in - the DataInput interface. The reason this class does not - implement DataInput is because it would break the interface - contract for those methods because of data format differences.

    -

    - -

    -

    -
    See Also:
    Tuple Formats
    -
    - -

    + the DataInput interface. The reason this class does not + implement DataInput is because it would break the interface + contract for those methods because of data format differences.

    +
    See Also:
    Tuple Formats
    +
    • +
+
+
+
    +
  • - - - - - - -
    -Field Summary
    -  - - - - - - - -
    Fields inherited from class com.sleepycat.util.FastInputStream
    buf, len, mark, off
    -  + - - - - - - - - - - - - - - - -
    -Constructor Summary
    TupleInput(byte[] buffer) - -
    -          Creates a tuple input object for reading a byte array of tuple data.
    TupleInput(byte[] buffer, - int offset, - int length) - -
    -          Creates a tuple input object for reading a byte array of tuple data at - a given offset for a given length.
    TupleInput(TupleOutput output) - -
    -          Creates a tuple input object from the data contained in a tuple output - object.
    -  +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      TupleInput(byte[] buffer) +
      Creates a tuple input object for reading a byte array of tuple data.
      +
      TupleInput(byte[] buffer, + int offset, + int length) +
      Creates a tuple input object for reading a byte array of tuple data at + a given offset for a given length.
      +
      TupleInput(TupleOutput output) +
      Creates a tuple input object from the data contained in a tuple output + object.
      +
      +
      • +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -Method Summary
    - intgetBigDecimalByteLength() - -
    -          Returns the byte length of an unsorted BigDecimal.
    - intgetBigIntegerByteLength() - -
    -          Returns the byte length of a BigInteger.
    - intgetPackedIntByteLength() - -
    -          Returns the byte length of a packed integer.
    - intgetPackedLongByteLength() - -
    -          Returns the byte length of a packed long integer.
    - intgetSortedBigDecimalByteLength() - -
    -          Returns the byte length of a sorted BigDecimal.
    - intgetSortedPackedIntByteLength() - -
    -          Returns the byte length of a sorted packed integer.
    - intgetSortedPackedLongByteLength() - -
    -          Returns the byte length of a sorted packed long integer.
    - intgetStringByteLength() - -
    -          Returns the byte length of a null-terminated UTF string in the data - buffer, including the terminator.
    - BigDecimalreadBigDecimal() - -
    -          Reads an unsorted BigDecimal.
    - BigIntegerreadBigInteger() - -
    -          Reads a BigInteger.
    - booleanreadBoolean() - -
    -          Reads a boolean (one byte) unsigned value from the buffer and returns - true if it is non-zero and false if it is zero.
    - bytereadByte() - -
    -          Reads a signed byte (one byte) value from the buffer.
    - voidreadBytes(char[] chars) - -
    -          Reads the specified number of bytes from the buffer, converting each - unsigned byte value to a character of the resulting array.
    - StringreadBytes(int length) - -
    -          Reads the specified number of bytes from the buffer, converting each - unsigned byte value to a character of the resulting string.
    - charreadChar() - -
    -          Reads a char (two byte) unsigned value from the buffer.
    - voidreadChars(char[] chars) - -
    -          Reads the specified number of characters from the buffer, converting - each two byte unsigned value to a character of the resulting array.
    - StringreadChars(int length) - -
    -          Reads the specified number of characters from the buffer, converting - each two byte unsigned value to a character of the resulting string.
    - doublereadDouble() - -
    -          Reads an unsorted double (eight byte) value from the buffer.
    - floatreadFloat() - -
    -          Reads an unsorted float (four byte) value from the buffer.
    - intreadInt() - -
    -          Reads a signed int (four byte) value from the buffer.
    - longreadLong() - -
    -          Reads a signed long (eight byte) value from the buffer.
    - intreadPackedInt() - -
    -          Reads an unsorted packed integer.
    - longreadPackedLong() - -
    -          Reads an unsorted packed long integer.
    - shortreadShort() - -
    -          Reads a signed short (two byte) value from the buffer.
    - BigDecimalreadSortedBigDecimal() - -
    -          Reads a sorted BigDecimal, with support for correct default - sorting.
    - doublereadSortedDouble() - -
    -          Reads a sorted double (eight byte) value from the buffer.
    - floatreadSortedFloat() - -
    -          Reads a sorted float (four byte) value from the buffer.
    - intreadSortedPackedInt() - -
    -          Reads a sorted packed integer.
    - longreadSortedPackedLong() - -
    -          Reads a sorted packed long integer.
    - StringreadString() - -
    -          Reads a null-terminated UTF string from the data buffer and converts - the data from UTF to Unicode.
    - voidreadString(char[] chars) - -
    -          Reads the specified number of UTF characters string from the data - buffer and converts the data from UTF to Unicode.
    - StringreadString(int length) - -
    -          Reads the specified number of UTF characters string from the data - buffer and converts the data from UTF to Unicode.
    - intreadUnsignedByte() - -
    -          Reads an unsigned byte (one byte) value from the buffer.
    - longreadUnsignedInt() - -
    -          Reads an unsigned int (four byte) value from the buffer.
    - intreadUnsignedShort() - -
    -          Reads an unsigned short (two byte) value from the buffer.
    -  - - - - - - - -
    Methods inherited from class com.sleepycat.util.FastInputStream
    available, getBufferBytes, getBufferLength, getBufferOffset, mark, markSupported, read, read, read, readFast, readFast, readFast, reset, skip, skipFast
    -  - - - - - - - -
    Methods inherited from class java.io.InputStream
    close
    -  - - - - - - - -
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    -  -

    - +

      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intgetBigDecimalByteLength() +
      Returns the byte length of an unsorted BigDecimal.
      +
      intgetBigIntegerByteLength() +
      Returns the byte length of a BigInteger.
      +
      intgetPackedIntByteLength() +
      Returns the byte length of a packed integer.
      +
      intgetPackedLongByteLength() +
      Returns the byte length of a packed long integer.
      +
      intgetSortedBigDecimalByteLength() +
      Returns the byte length of a sorted BigDecimal.
      +
      intgetSortedPackedIntByteLength() +
      Returns the byte length of a sorted packed integer.
      +
      intgetSortedPackedLongByteLength() +
      Returns the byte length of a sorted packed long integer.
      +
      intgetStringByteLength() +
      Returns the byte length of a null-terminated UTF string in the data + buffer, including the terminator.
      +
      java.math.BigDecimalreadBigDecimal() +
      Reads an unsorted BigDecimal.
      +
      java.math.BigIntegerreadBigInteger() +
      Reads a BigInteger.
      +
      booleanreadBoolean() +
      Reads a boolean (one byte) unsigned value from the buffer and returns + true if it is non-zero and false if it is zero.
      +
      bytereadByte() +
      Reads a signed byte (one byte) value from the buffer.
      +
      voidreadBytes(char[] chars) +
      Reads the specified number of bytes from the buffer, converting each + unsigned byte value to a character of the resulting array.
      +
      java.lang.StringreadBytes(int length) +
      Reads the specified number of bytes from the buffer, converting each + unsigned byte value to a character of the resulting string.
      +
      charreadChar() +
      Reads a char (two byte) unsigned value from the buffer.
      +
      voidreadChars(char[] chars) +
      Reads the specified number of characters from the buffer, converting + each two byte unsigned value to a character of the resulting array.
      +
      java.lang.StringreadChars(int length) +
      Reads the specified number of characters from the buffer, converting + each two byte unsigned value to a character of the resulting string.
      +
      doublereadDouble() +
      Reads an unsorted double (eight byte) value from the buffer.
      +
      floatreadFloat() +
      Reads an unsorted float (four byte) value from the buffer.
      +
      intreadInt() +
      Reads a signed int (four byte) value from the buffer.
      +
      longreadLong() +
      Reads a signed long (eight byte) value from the buffer.
      +
      intreadPackedInt() +
      Reads an unsorted packed integer.
      +
      longreadPackedLong() +
      Reads an unsorted packed long integer.
      +
      shortreadShort() +
      Reads a signed short (two byte) value from the buffer.
      +
      java.math.BigDecimalreadSortedBigDecimal() +
      Reads a sorted BigDecimal, with support for correct default + sorting.
      +
      doublereadSortedDouble() +
      Reads a sorted double (eight byte) value from the buffer.
      +
      floatreadSortedFloat() +
      Reads a sorted float (four byte) value from the buffer.
      +
      intreadSortedPackedInt() +
      Reads a sorted packed integer.
      +
      longreadSortedPackedLong() +
      Reads a sorted packed long integer.
      +
      java.lang.StringreadString() +
      Reads a null-terminated UTF string from the data buffer and converts + the data from UTF to Unicode.
      +
      voidreadString(char[] chars) +
      Reads the specified number of UTF characters string from the data + buffer and converts the data from UTF to Unicode.
      +
      java.lang.StringreadString(int length) +
      Reads the specified number of UTF characters string from the data + buffer and converts the data from UTF to Unicode.
      +
      intreadUnsignedByte() +
      Reads an unsigned byte (one byte) value from the buffer.
      +
      longreadUnsignedInt() +
      Reads an unsigned int (four byte) value from the buffer.
      +
      intreadUnsignedShort() +
      Reads an unsigned short (two byte) value from the buffer.
      +
      + +
        +
      • + + +

        Methods inherited from class java.io.InputStream

        +close
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

    -TupleInput

    -
    -public TupleInput(byte[] buffer)
    -
    -
    Creates a tuple input object for reading a byte array of tuple data. A +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TupleInput

        +
        public TupleInput(byte[] buffer)
        +
        Creates a tuple input object for reading a byte array of tuple data. A reference to the byte array will be kept by this object (it will not be copied) and therefore the byte array should not be modified while this - object is in use. -

        -

        -
        Parameters:
        buffer - is the byte array to be read and should contain data in - tuple format.
        -
    -
    - -

    -TupleInput

    -
    -public TupleInput(byte[] buffer,
-                  int offset,
-                  int length)
    -
    -
    Creates a tuple input object for reading a byte array of tuple data at + object is in use.
+
Parameters:
buffer - is the byte array to be read and should contain data in + tuple format.
+ + + + + + + + + + + + - - - - - - -
-Method Detail
- -

-readString

-
-public final String readString()
-                        throws IndexOutOfBoundsException,
-                               IllegalArgumentException
-
-
Reads a null-terminated UTF string from the data buffer and converts +
    +
  • + + +

    Method Detail

    + + + +
      +
    • +

      readString

      +
      public final java.lang.String readString()
+                                  throws java.lang.IndexOutOfBoundsException,
+                                         java.lang.IllegalArgumentException
      +
      Reads a null-terminated UTF string from the data buffer and converts the data from UTF to Unicode. - Reads values that were written using TupleOutput.writeString(String). -

      -

      - -
      Returns:
      the converted string. -
      Throws: -
      IndexOutOfBoundsException - if no null terminating byte is found - in the buffer. -
      IllegalArgumentException - malformed UTF data is encountered.
      See Also:
      String Formats
      -
      -
-
- -

-readChar

-
-public final char readChar()
-                    throws IndexOutOfBoundsException
-
-
Reads a char (two byte) unsigned value from the buffer. - Reads values that were written using TupleOutput.writeChar(int). -

-

- -
Returns:
the value read from the buffer. -
Throws: -
IndexOutOfBoundsException - if not enough bytes are available in - the buffer.
See Also:
Integer Formats
-
-
-
- -

-readBoolean

-
-public final boolean readBoolean()
-                          throws IndexOutOfBoundsException
-
-
Reads a boolean (one byte) unsigned value from the buffer and returns + Reads values that were written using TupleOutput.writeString(String).
+
Returns:
the converted string.
+
Throws:
+
java.lang.IndexOutOfBoundsException - if no null terminating byte is found + in the buffer.
+
java.lang.IllegalArgumentException - malformed UTF data is encountered.
See Also:
String Formats
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
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