com.tangosol.io.WrapperBufferOutput

All Implemented Interfaces:: com.oracle.coherence.common.io.OutputStreaming, OutputStreaming, WriteBuffer.BufferOutput, DataOutput

Direct Known Subclasses:: WrapperBufferOutput.VersionAwareBufferOutput

public class WrapperBufferOutput extends Base implements WriteBuffer.BufferOutput

This is an imitation BufferOutput implementation that provides the BufferOutput interface by delegating to an object that implements the DataOutput interface. Primarily, this is intended as a base class for building specific-purpose DataOutput wrappers.

Author:: jh 2007.11.17

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

WrapperBufferOutput.VersionAwareBufferOutput

A BufferOutput implementation that in addition to delegating to the given DataOutput provides an API to check whether the recipients of the content of this BufferOutput run versions that supersede (greater or equal to) the specified version.

Nested classes/interfaces inherited from class com.tangosol.util.Base
Base.LoggingWriter
Field Summary

Fields inherited from class com.tangosol.util.Base
LOG_ALWAYS, LOG_CONFIG, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Fields inherited from interface com.tangosol.io.WriteBuffer.BufferOutput
MAX_PACKED_INT_SIZE, MAX_PACKED_LONG_SIZE
Constructor Summary

Constructors

Constructor

Description

WrapperBufferOutput(DataOutput out)

Construct a WrapperBufferOutput that will write to the specified object implementing the DataOutput interface.
Method Summary

Modifier and Type

Method

Description

void

close()

Close the OutputStream and release any system resources associated with it.

void

flush()

Flushes this OutputStream and forces any buffered output bytes to be written.

WriteBuffer

getBuffer()

Get the WriteBuffer object that this BufferOutput is writing to.

DataOutput

getDataOutput()

Obtain the underlying object providing the DataOutput interface that this object is delegating 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

write(byte[] ab)

Writes all the bytes in the array ab.

void

write(byte[] ab, int of, int cb)

Writes cb bytes starting at offset of from the array ab.

void

write(int b)

Writes the eight low-order bits of the argument b.

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 n)

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 class com.tangosol.util.Base
azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mergeArray, mergeBooleanArray, mergeByteArray, mergeCharArray, mergeDoubleArray, mergeFloatArray, mergeIntArray, mergeLongArray, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- WrapperBufferOutput
  
  public WrapperBufferOutput(DataOutput out)
  
  Construct a WrapperBufferOutput that will write to the specified object implementing the DataOutput interface.
  
  Parameters:
  
  out - an object implementing DataOutput to write to
Method Details
- write
  
  public void write(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:
  
  write in interface DataOutput
  
  Specified by:
  
  write in interface com.oracle.coherence.common.io.OutputStreaming
  
  Parameters:
  
  b - the byte to write (passed as an integer)
  
  Throws:
  
  IOException - if an I/O error occurs
- write
  
  public void write(byte[] ab) throws IOException
  
  Writes all the bytes in the array ab.
  
  Specified by:
  
  write in interface DataOutput
  
  Specified by:
  
  write in interface com.oracle.coherence.common.io.OutputStreaming
  
  Parameters:
  
  ab - the byte array to write
  
  Throws:
  
  IOException - if an I/O error occurs
- write
  
  public void write(byte[] ab, int of, int cb) throws IOException
  
  Writes cb bytes starting at offset of from the array ab.
  
  Specified by:
  
  write in interface DataOutput
  
  Specified by:
  
  write in interface com.oracle.coherence.common.io.OutputStreaming
  
  Parameters:
  
  ab - the byte array to write from
  
  of - the offset into ab to start writing from
  
  cb - the number of bytes from ab to write
  
  Throws:
  
  IOException - if an I/O error occurs
- flush
  
  public void flush() throws IOException
  
  Flushes this OutputStream and forces any buffered output bytes to be written.
  
  Specified by:
  
  flush in interface com.oracle.coherence.common.io.OutputStreaming
  
  Throws:
  
  IOException - if an I/O error occurs
- close
  
  public 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
  
  Specified by:
  
  close in interface WriteBuffer.BufferOutput
  
  Throws:
  
  IOException - if an I/O error occurs
- writeBoolean
  
  public void writeBoolean(boolean f) throws IOException
  
  Writes the boolean value f.
  
  Specified by:
  
  writeBoolean in interface DataOutput
  
  Specified by:
  
  writeBoolean in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  f - the boolean to be written
  
  Throws:
  
  IOException - if an I/O error occurs
- writeByte
  
  public 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
  
  Specified by:
  
  writeByte in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  b - the byte to write (passed as an integer)
  
  Throws:
  
  IOException - if an I/O error occurs
- writeShort
  
  public 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
  
  Specified by:
  
  writeShort in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  n - the short to write (passed as an integer)
  
  Throws:
  
  IOException - if an I/O error occurs
- writeChar
  
  public void writeChar(int n) 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
  
  Specified by:
  
  writeChar in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  n - the char to write (passed as an integer)
  
  Throws:
  
  IOException - if an I/O error occurs
- writeInt
  
  public void writeInt(int n) throws IOException
  
  Writes an int value.
  
  Specified by:
  
  writeInt in interface DataOutput
  
  Specified by:
  
  writeInt in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  n - the int to write
  
  Throws:
  
  IOException - if an I/O error occurs
- writeLong
  
  public void writeLong(long l) throws IOException
  
  Writes a long value.
  
  Specified by:
  
  writeLong in interface DataOutput
  
  Specified by:
  
  writeLong in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  l - the long to write
  
  Throws:
  
  IOException - if an I/O error occurs
- writeFloat
  
  public void writeFloat(float fl) throws IOException
  
  Writes a float value.
  
  Specified by:
  
  writeFloat in interface DataOutput
  
  Specified by:
  
  writeFloat in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  fl - the float to write
  
  Throws:
  
  IOException - if an I/O error occurs
- writeDouble
  
  public void writeDouble(double dfl) throws IOException
  
  Writes a double value.
  
  Specified by:
  
  writeDouble in interface DataOutput
  
  Specified by:
  
  writeDouble in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  dfl - the double to write
  
  Throws:
  
  IOException - if an I/O error occurs
- writeBytes
  
  public 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
  
  Specified by:
  
  writeBytes in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  s - the String to write
  
  Throws:
  
  IOException - if an I/O error occurs
- writeChars
  
  public void writeChars(String s) throws IOException
  
  Writes the String s as a sequence of characters.
  
  Specified by:
  
  writeChars in interface DataOutput
  
  Specified by:
  
  writeChars in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  s - the String to write
  
  Throws:
  
  IOException - if an I/O error occurs
- writeUTF
  
  public 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
  
  Specified by:
  
  writeUTF in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  s - the String to write
  
  Throws:
  
  IOException - if an I/O error occurs
- getBuffer
  
  public WriteBuffer getBuffer()
  
  Get the WriteBuffer object that this BufferOutput is writing to.
  
  Specified by:
  
  getBuffer in interface WriteBuffer.BufferOutput
  
  Returns:
  
  the underlying WriteBuffer object
- writeSafeUTF
  
  public 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.
  
  Specified by:
  
  writeSafeUTF in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  s - a String value to write; may be null
  
  Throws:
  
  IOException - if an I/O error occurs
- writePackedInt
  
  public 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.
  
  Specified by:
  
  writePackedInt in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  n - an int value to write
  
  Throws:
  
  IOException - if an I/O error occurs
- writePackedLong
  
  public 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.
  
  Specified by:
  
  writePackedLong in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  l - a long value to write
  
  Throws:
  
  IOException - if an I/O error occurs
- writeBuffer
  
  public 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);
  Specified by:
  
  writeBuffer in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  buf - a ReadBuffer object
  
  Throws:
  
  IOException - if an I/O error occurs
- writeBuffer
  
  public 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);
  Specified by:
  
  writeBuffer in interface WriteBuffer.BufferOutput
  
  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
  
  public 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);
  Specified by:
  
  writeStream in interface WriteBuffer.BufferOutput
  
  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
  
  public 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);
  Specified by:
  
  writeStream in interface WriteBuffer.BufferOutput
  
  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:
  
  IOException - if an I/O error occurs, specifically if an IOException occurs reading from the passed stream
- getOffset
  
  public int getOffset()
  
  Determine the current offset of this BufferOutput within the underlying WriteBuffer.
  
  Specified by:
  
  getOffset in interface WriteBuffer.BufferOutput
  
  Returns:
  
  the offset of the next byte to write to the WriteBuffer
- setOffset
  
  public void setOffset(int of)
  
  Specify the offset of the next byte to write to the underlying WriteBuffer.
  
  Specified by:
  
  setOffset in interface WriteBuffer.BufferOutput
  
  Parameters:
  
  of - the offset of the next byte to write to the WriteBuffer
- getDataOutput
  
  public DataOutput getDataOutput()
  
  Obtain the underlying object providing the DataOutput interface that this object is delegating to.
  
  Returns:
  
  the underlying DataOutput

Class WrapperBufferOutput

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.Base

Field Summary

Fields inherited from class com.tangosol.util.Base

Fields inherited from interface com.tangosol.io.WriteBuffer.BufferOutput

Constructor Summary

Method Summary

Methods inherited from class com.tangosol.util.Base

Methods inherited from class java.lang.Object

Constructor Details

WrapperBufferOutput

Method Details

write

write

write

flush

close

writeBoolean

writeByte

writeShort

writeChar

writeInt

writeLong

writeFloat

writeDouble

writeBytes

writeChars

writeUTF

getBuffer

writeSafeUTF

writePackedInt

writePackedLong

writeBuffer

writeBuffer

writeStream

writeStream

getOffset

setOffset

getDataOutput