Package com.tangosol.io

Interface WriteBuffer.BufferOutput

All Superinterfaces:
DataOutput, com.oracle.coherence.common.io.OutputStreaming, OutputStreaming
All Known Implementing Classes:
AbstractWriteBuffer.AbstractBufferOutput, ByteArrayWriteBuffer.ByteArrayBufferOutput, ByteBufferWriteBuffer.ByteBufferOutput, DelegatingWriteBuffer.DelegatingBufferOutput, MultiBufferWriteBuffer.MultiBufferOutput, SizeEstimatingBufferOutput, WrapperBufferOutput, WrapperBufferOutput.VersionAwareBufferOutput
Enclosing interface:
WriteBuffer
public static interface WriteBuffer.BufferOutput extends OutputStreaming, DataOutput
The BufferOutput interface represents a DataOutputStream on top of a WriteBuffer.
Author:
cp 2005.01.18

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MAX_PACKED_INT_SIZE
    Maximum encoding length for a packed int value.
    static final int
    MAX_PACKED_LONG_SIZE
    Maximum encoding length for a packed long value.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Close the OutputStream and release any system resources associated with it.
    WriteBuffer
    getBuffer()
    Get the WriteBuffer object that this BufferOutput is writing to.
    int
    getOffset()
    Determine the current offset of this BufferOutput within the underlying WriteBuffer.
    void
    setOffset(int of)
    Specify the offset of the next byte to write to the underlying WriteBuffer.
    void
    writeBoolean(boolean f)
    Writes the boolean value f.
    void
    writeBuffer(ReadBuffer buf)
    Write all the bytes from the passed ReadBuffer object.
    void
    writeBuffer(ReadBuffer buf, int of, int cb)
    Write cb bytes from the passed ReadBuffer object starting at offset of within the passed ReadBuffer.
    void
    writeByte(int b)
    Writes the eight low-order bits of the argument b.
    void
    writeBytes(String s)
    Writes the String s, but only the low-order byte from each character of the String is written.
    void
    writeChar(int ch)
    Writes a char value, comprised of the 16 low-order bits of the argument ch; the 16 high-order bits of ch are ignored.
    void
    writeChars(String s)
    Writes the String s as a sequence of characters.
    void
    writeDouble(double dfl)
    Writes a double value.
    void
    writeFloat(float fl)
    Writes a float value.
    void
    writeInt(int n)
    Writes an int value.
    void
    writeLong(long l)
    Writes a long value.
    void
    writePackedInt(int n)
    Write an int value using a variable-length storage-format.
    void
    writePackedLong(long l)
    Write a long value using a variable-length storage-format.
    void
    writeSafeUTF(String s)
    Write a variable-length encoded UTF packed String.
    void
    writeShort(int n)
    Writes a short value, comprised of the 16 low-order bits of the argument n; the 16 high-order bits of n are ignored.
    void
    writeStream(InputStreaming stream)
    Write the remaining contents of the specified InputStreaming object.
    void
    writeStream(InputStreaming stream, int cb)
    Write the specified number of bytes of the specified InputStreaming object.
    void
    writeUTF(String s)
    Writes the String s as a sequence of characters, but using UTF-8 encoding for the characters, and including the String length data so that the corresponding DataInput.readUTF() method can reconstitute a String from the written data.

    Methods inherited from interface java.io.DataOutput

    write, write, write

    Methods inherited from interface com.oracle.coherence.common.io.OutputStreaming

    flush, write, write, write

  • Field Details

    • MAX_PACKED_INT_SIZE

      static final int MAX_PACKED_INT_SIZE
      Maximum encoding length for a packed int value.
      See Also:

    • MAX_PACKED_LONG_SIZE

      static final int MAX_PACKED_LONG_SIZE
      Maximum encoding length for a packed long value.
      See Also:

  • Method Details

    • close

      void close() throws IOException
      Close the OutputStream and release any system resources associated with it.

      BufferOutput implementations do not pass this call down onto an underlying stream, if any.

      Specified by:
      close in interface com.oracle.coherence.common.io.OutputStreaming
      Throws:
      IOException - if an I/O error occurs

    • writeBoolean

      void writeBoolean(boolean f) throws IOException
      Writes the boolean value f.
      Specified by:
      writeBoolean in interface DataOutput
      Parameters:
      f - the boolean to be written
      Throws:
      IOException - if an I/O error occurs

    • writeByte

      void writeByte(int b) throws IOException
      Writes the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.
      Specified by:
      writeByte in interface DataOutput
      Parameters:
      b - the byte to write (passed as an integer)
      Throws:
      IOException - if an I/O error occurs

    • writeShort

      void writeShort(int n) throws IOException
      Writes a short value, comprised of the 16 low-order bits of the argument n; the 16 high-order bits of n are ignored.
      Specified by:
      writeShort in interface DataOutput
      Parameters:
      n - the short to write (passed as an integer)
      Throws:
      IOException - if an I/O error occurs

    • writeChar

      void writeChar(int ch) throws IOException
      Writes a char value, comprised of the 16 low-order bits of the argument ch; the 16 high-order bits of ch are ignored.
      Specified by:
      writeChar in interface DataOutput
      Parameters:
      ch - the char to write (passed as an integer)
      Throws:
      IOException - if an I/O error occurs

    • writeInt

      void writeInt(int n) throws IOException
      Writes an int value.
      Specified by:
      writeInt in interface DataOutput
      Parameters:
      n - the int to write
      Throws:
      IOException - if an I/O error occurs

    • writeLong

      void writeLong(long l) throws IOException
      Writes a long value.
      Specified by:
      writeLong in interface DataOutput
      Parameters:
      l - the long to write
      Throws:
      IOException - if an I/O error occurs

    • writeFloat

      void writeFloat(float fl) throws IOException
      Writes a float value.
      Specified by:
      writeFloat in interface DataOutput
      Parameters:
      fl - the float to write
      Throws:
      IOException - if an I/O error occurs

    • writeDouble

      void writeDouble(double dfl) throws IOException
      Writes a double value.
      Specified by:
      writeDouble in interface DataOutput
      Parameters:
      dfl - the double to write
      Throws:
      IOException - if an I/O error occurs

    • writeBytes

      void writeBytes(String s) throws IOException
      Writes the String s, but only the low-order byte from each character of the String is written.
      Specified by:
      writeBytes in interface DataOutput
      Parameters:
      s - the String to write
      Throws:
      IOException - if an I/O error occurs
      NullPointerException - if s is null

    • writeChars

      void writeChars(String s) throws IOException
      Writes the String s as a sequence of characters.
      Specified by:
      writeChars in interface DataOutput
      Parameters:
      s - the String to write
      Throws:
      IOException - if an I/O error occurs
      NullPointerException - if s is null

    • writeUTF

      void writeUTF(String s) throws IOException
      Writes the String s as a sequence of characters, but using UTF-8 encoding for the characters, and including the String length data so that the corresponding DataInput.readUTF() method can reconstitute a String from the written data.
      Specified by:
      writeUTF in interface DataOutput
      Parameters:
      s - the String to write
      Throws:
      IOException - if an I/O error occurs
      NullPointerException - if s is null

    • getBuffer

      WriteBuffer getBuffer()
      Get the WriteBuffer object that this BufferOutput is writing to.
      Returns:
      the underlying WriteBuffer object

    • writeSafeUTF

      void writeSafeUTF(String s) throws IOException
      Write a variable-length encoded UTF packed String. The major differences between this implementation and DataOutput is that this implementation supports null values and is not limited to 64KB UTF-encoded values.

      The binary format for a Safe UTF value is a "packed int" for the binary length followed by the UTF-encoded byte stream. The length is either -1 (indicating a null String) or in the range 0 .. Integer.MAX_VALUE (inclusive). The UTF-encoded portion uses a format identical to DataOutput.

      Parameters:
      s - a String value to write; may be null
      Throws:
      IOException - if an I/O error occurs

    • writePackedInt

      void writePackedInt(int n) throws IOException
      Write an int value using a variable-length storage-format.

      The format differs from DataOutput in that DataOutput always uses a fixed-length 4-byte Big Endian binary format for int values. The "packed" format includes a sign bit (0x40) and a continuation bit (0x80) in the first byte, followed by the least 6 significant bits of the int value. Subsequent bytes (each appearing only if the previous byte had its continuation bit set) include a continuation bit (0x80) and the next least 7 significant bits of the int value. In this way, a 32-bit value is encoded into 1-5 bytes, depending on the magnitude of the int value being encoded.

      Parameters:
      n - an int value to write
      Throws:
      IOException - if an I/O error occurs

    • writePackedLong

      void writePackedLong(long l) throws IOException
      Write a long value using a variable-length storage-format.

      The format differs from DataOutput in that DataOutput always uses a fixed-length 8-byte Big Endian binary format for long values. The "packed" format includes a sign bit (0x40) and a continuation bit (0x80) in the first byte, followed by the least 6 significant bits of the long value. Subsequent bytes (each appearing only if the previous byte had its continuation bit set) include a continuation bit (0x80) and the next least 7 significant bits of the long value. In this way, a 64-bit value is encoded into 1-10 bytes, depending on the magnitude of the long value being encoded.

      Parameters:
      l - a long value to write
      Throws:
      IOException - if an I/O error occurs

    • writeBuffer

      void writeBuffer(ReadBuffer buf) throws IOException
      Write all the bytes from the passed ReadBuffer object.

      This is functionally equivalent to the following code: 

      
 getBuffer().write(getOffset(), buf);
      Parameters:
      buf - a ReadBuffer object
      Throws:
      IOException - if an I/O error occurs

    • writeBuffer

      void writeBuffer(ReadBuffer buf, int of, int cb) throws IOException
      Write cb bytes from the passed ReadBuffer object starting at offset of within the passed ReadBuffer.

      This is functionally equivalent to the following code: 

      
 getBuffer().write(getOffset(), buf, of, cb);
      Parameters:
      buf - a ReadBuffer object
      of - the offset within the ReadBuffer of the first byte to write to this BufferOutput
      cb - the number of bytes to write
      Throws:
      IOException - if an I/O error occurs

    • writeStream

      void writeStream(InputStreaming stream) throws IOException
      Write the remaining contents of the specified InputStreaming object.

      This is functionally equivalent to the following code: 

      
 getBuffer().write(getOffset(), stream);
      Parameters:
      stream - the stream of bytes to write to this BufferOutput
      Throws:
      IOException - if an I/O error occurs, specifically if an IOException occurs reading from the passed stream

    • writeStream

      void writeStream(InputStreaming stream, int cb) throws IOException
      Write the specified number of bytes of the specified InputStreaming object.

      This is functionally equivalent to the following code: 

      
 getBuffer().write(getOffset(), stream, cb);
      Parameters:
      stream - the stream of bytes to write to this BufferOutput
      cb - the exact number of bytes to read from the stream and write to this BufferOutput
      Throws:
      EOFException - if the stream is exhausted before the number of bytes indicated could be read
      IOException - if an I/O error occurs, specifically if an IOException occurs reading from the passed stream

    • getOffset

      int getOffset()
      Determine the current offset of this BufferOutput within the underlying WriteBuffer.
      Returns:
      the offset of the next byte to write to the WriteBuffer

    • setOffset

      void setOffset(int of)
      Specify the offset of the next byte to write to the underlying WriteBuffer.
      Parameters:
      of - the offset of the next byte to write to the WriteBuffer
      Throws:
      IndexOutOfBoundsException - if of < 0 or of > getBuffer().getMaximumCapacity()