Skip navigation links

Oracle® Coherence Java API Reference
v3.5.1

E15583-01


com.tangosol.io
Class MultiBufferWriteBuffer.MultiBufferOutput

java.lang.Object
  extended by com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput
      extended by com.tangosol.io.MultiBufferWriteBuffer.MultiBufferOutput

All Implemented Interfaces:
OutputStreaming, WriteBuffer.BufferOutput, java.io.DataOutput
Enclosing class:
MultiBufferWriteBuffer

public class MultiBufferWriteBuffer.MultiBufferOutput
extends AbstractWriteBuffer.AbstractBufferOutput

The MultiBufferOutput implementation extends the AbstractBufferOutput to provide "pass through" operations to the underlying buffer if the operation is guaranteed to fit in the underlying buffer; otherwise, it vitualizes the operation onto the MultiBufferWriteBuffer itself so that the over-run of one underlying WriteBuffer will end up being written to the next underlying WriteBuffer. <p/> This implementation is fairly tightly bound to the super-class implementation; changes to AbstractBufferOutput should be carefully evaluated for potential impacts on this class.


Field Summary

 

Fields inherited from class com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput
m_ofWrite

 

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

 

Constructor Summary
MultiBufferWriteBuffer.MultiBufferOutput(int of)
          Construct an AbstractBufferOutput that will begin writing at the specified offset within the containing WriteBuffer.

 

Method Summary
protected  void adjust(int cb)
          Adjust the offset of this BufferOutput based on a write that by-passed this BufferOutput's own super-class implementation that is responsible for maintaining the offset.
protected  WriteBuffer.BufferOutput getOut()
          Obtain the underlying BufferOutput.
protected  boolean hasRemaining(int cb)
          Determine if it is possible to write something of a specified length to the underlying buffer.
 void setOffset(int of)
          Specify the offset of the next byte to write to the underlying WriteBuffer.
protected  void sync()
          After traversing an underlying WriteBuffer boundary, or otherwise changing the offset significantly, sync between this BufferOutput's absolute position and an underlying BufferOutput's relative position.
 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 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 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 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 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.

 

Methods inherited from class com.tangosol.io.AbstractWriteBuffer.AbstractBufferOutput
calcUTF, close, flush, formatUTF, getBuffer, getCharBuf, getOffset, writeBoolean, writeByte, writeBytes, writeChars, writePackedInt, writePackedLong, writeSafeUTF, writeUTF

 

Constructor Detail

MultiBufferWriteBuffer.MultiBufferOutput

public MultiBufferWriteBuffer.MultiBufferOutput(int of)
Construct an AbstractBufferOutput that will begin writing at the specified offset within the containing WriteBuffer.
Parameters:
of - the offset at which to begin writing

Method Detail

write

public void write(int b)
           throws java.io.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 OutputStreaming
Specified by:
write in interface java.io.DataOutput
Overrides:
write in class AbstractWriteBuffer.AbstractBufferOutput
Parameters:
b - the byte to write (passed as an integer)
Throws:
java.io.IOException - if an I/O error occurs

write

public void write(byte[] ab)
           throws java.io.IOException
Writes all the bytes in the array ab.
Specified by:
write in interface OutputStreaming
Specified by:
write in interface java.io.DataOutput
Overrides:
write in class AbstractWriteBuffer.AbstractBufferOutput
Parameters:
ab - the byte array to write
Throws:
java.io.IOException - if an I/O error occurs

write

public void write(byte[] ab,
                  int of,
                  int cb)
           throws java.io.IOException
Writes cb bytes starting at offset of from the array ab.
Specified by:
write in interface OutputStreaming
Specified by:
write in interface java.io.DataOutput
Overrides:
write in class AbstractWriteBuffer.AbstractBufferOutput
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:
java.io.IOException - if an I/O error occurs

writeShort

public void writeShort(int n)
                throws java.io.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 java.io.DataOutput
Overrides:
writeShort in class AbstractWriteBuffer.AbstractBufferOutput
Parameters:
n - the short to write (passed as an integer)
Throws:
java.io.IOException - if an I/O error occurs

writeChar

public void writeChar(int ch)
               throws java.io.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 java.io.DataOutput
Overrides:
writeChar in class AbstractWriteBuffer.AbstractBufferOutput
Parameters:
ch - the char to write (passed as an integer)
Throws:
java.io.IOException - if an I/O error occurs

writeInt

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

writeLong

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

writeFloat

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

writeDouble

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

writeBuffer

public void writeBuffer(ReadBuffer buf)
                 throws java.io.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
Overrides:
writeBuffer in class AbstractWriteBuffer.AbstractBufferOutput
Parameters:
buf - a ReadBuffer object
Throws:
java.io.IOException - if an I/O error occurs

writeBuffer

public void writeBuffer(ReadBuffer buf,
                        int of,
                        int cb)
                 throws java.io.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
Overrides:
writeBuffer in class AbstractWriteBuffer.AbstractBufferOutput
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:
java.io.IOException - if an I/O error occurs

writeStream

public void writeStream(InputStreaming stream)
                 throws java.io.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
Overrides:
writeStream in class AbstractWriteBuffer.AbstractBufferOutput
Parameters:
stream - the stream of bytes to write to this BufferOutput
Throws:
java.io.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 java.io.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
Overrides:
writeStream in class AbstractWriteBuffer.AbstractBufferOutput
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:
java.io.EOFException - if the stream is exhausted before the number of bytes indicated could be read
java.io.IOException - if an I/O error occurs, specifically if an IOException occurs reading from the passed stream

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
Overrides:
setOffset in class AbstractWriteBuffer.AbstractBufferOutput
Parameters:
of - the offset of the next byte to write to the WriteBuffer

getOut

protected WriteBuffer.BufferOutput getOut()
Obtain the underlying BufferOutput.
Returns:
the underlying BufferOutput

hasRemaining

protected boolean hasRemaining(int cb)
Determine if it is possible to write something of a specified length to the underlying buffer.
Parameters:
cb - the length to write
Returns:
true if there are at least cb bytes remaining to be written in the underlying buffer

adjust

protected void adjust(int cb)
Adjust the offset of this BufferOutput based on a write that by-passed this BufferOutput's own super-class implementation that is responsible for maintaining the offset.
Parameters:
cb - the number of bytes that were just written directly to the underlying BufferOutput

sync

protected void sync()
After traversing an underlying WriteBuffer boundary, or otherwise changing the offset significantly, sync between this BufferOutput's absolute position and an underlying BufferOutput's relative position.

Skip navigation links

Oracle® Coherence Java API Reference
v3.5.1

E15583-01


Copyright © 2000, 2009, Oracle. All rights reserved.