|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tangosol.io.AbstractWriteBuffer
com.tangosol.io.nio.ByteBufferWriteBuffer
public class ByteBufferWriteBuffer
A WriteBuffer implementation on top of a Java NIO ByteBuffer.
Nested Class Summary | |
---|---|
class |
ByteBufferWriteBuffer.ByteBufferOutput
This is a simple implementation of the BufferOutput interface on top of a ByteBuffer. |
Nested classes/interfaces inherited from class com.tangosol.io.AbstractWriteBuffer |
---|
AbstractWriteBuffer.AbstractBufferOutput |
Nested classes/interfaces inherited from interface com.tangosol.io.WriteBuffer |
---|
WriteBuffer.BufferOutput |
Field Summary |
---|
Fields inherited from class com.tangosol.io.AbstractWriteBuffer |
---|
CHAR_BUF_MASK, CHAR_BUF_SIZE, m_achBuf, NO_BINARY, NO_BYTES |
Constructor Summary | |
---|---|
ByteBufferWriteBuffer(ByteBuffer buf)
Construct a ByteBufferWriteBuffer on an NIO ByteBuffer. |
Method Summary | |
---|---|
Object |
clone()
Create a clone of this WriteBuffer object. |
WriteBuffer.BufferOutput |
getBufferOutput(int of)
Get a BufferOutput object to write data to this buffer starting at a particular offset. |
ByteBuffer |
getByteBuffer()
Obtain the ByteBuffer that this WriteBuffer is based on. |
int |
getCapacity()
Determine the number of bytes that the buffer can hold without resizing itself. |
ReadBuffer |
getReadBuffer()
Get a ReadBuffer object that is a snapshot of this WriteBuffer's data. |
ReadBuffer |
getUnsafeReadBuffer()
Get a ReadBuffer object to read data from this buffer. |
int |
length()
Determine the length of the data that is in the buffer. |
void |
retain(int of,
int cb)
Starting with the byte at offset of, retain cb bytes in this WriteBuffer, such that the byte at offset of is shifted to offset 0, the byte at offset of + 1 is shifted to offset 1, and so on up to the byte at offset of + cb - 1, which is shifted to offset cb - 1. |
Binary |
toBinary()
Returns a new Binary object that holds the complete contents of this WriteBuffer. |
byte[] |
toByteArray()
Returns a new byte array that holds the complete contents of this WriteBuffer. |
void |
write(int ofDest,
byte b)
Store the specified byte at the specified offset within the buffer. |
void |
write(int ofDest,
byte[] abSrc,
int ofSrc,
int cbSrc)
Store the specified number of bytes from the specified location within the passed byte array at the specified offset within this buffer. |
void |
write(int ofDest,
ReadBuffer bufSrc,
int ofSrc,
int cbSrc)
Store the specified portion of the contents of the specified ReadBuffer at the specified offset within this buffer. |
Methods inherited from class com.tangosol.io.AbstractWriteBuffer |
---|
clear, copyStream, getAppendingBufferOutput, getBufferOutput, getMaximumCapacity, getWriteBuffer, getWriteBuffer, retain, tmpbuf, tmpbuf, write, write, write, write |
Methods inherited from interface com.tangosol.io.WriteBuffer |
---|
clear, getAppendingBufferOutput, getBufferOutput, getMaximumCapacity, getWriteBuffer, getWriteBuffer, retain, write, write, write, write |
Constructor Detail |
---|
public ByteBufferWriteBuffer(ByteBuffer buf)
buf
- the underlying NIO ByteBufferMethod Detail |
---|
public ByteBuffer getByteBuffer()
public void write(int ofDest, byte b)
For purposes of side-effects and potential exceptions, this method is functionally equivalent to the following code:
byte[] abSrc = new byte[1];
abSrc[0] = b;
write(ofDest, abSrc, 0, abSrc.length);
write
in interface WriteBuffer
write
in class AbstractWriteBuffer
ofDest
- the offset within this buffer to store the passed datab
- the byte to store in this bufferpublic void write(int ofDest, byte[] abSrc, int ofSrc, int cbSrc)
As a result of this method, the buffer length as reported by the
AbstractWriteBuffer.length()
method will become
Math.max(AbstractWriteBuffer.length()
, ofDest + cbSrc).
As a result of this method, the buffer capacity as reported by the
AbstractWriteBuffer.getCapacity()
method will not change if the new value
returned by AbstractWriteBuffer.length()
would not exceed the old value
returned by AbstractWriteBuffer.getCapacity()
; otherwise, the capacity
will be increased such that
AbstractWriteBuffer.getCapacity()
>= AbstractWriteBuffer.length()
. Regardless, it is
always true that AbstractWriteBuffer.getCapacity()
>= AbstractWriteBuffer.length()
and AbstractWriteBuffer.getMaximumCapacity()
>= AbstractWriteBuffer.getCapacity()
.
If the buffer capacity cannot be increased due to resource constraints,
an undesignated Error or RuntimeException will be thrown, such as
OutOfMemoryError.
write
in interface WriteBuffer
write
in class AbstractWriteBuffer
ofDest
- the offset within this buffer to store the passed dataabSrc
- the array containing the bytes to store in this bufferofSrc
- the offset within the passed byte array to copy fromcbSrc
- the number of bytes to copy from the passed byte arraypublic void write(int ofDest, ReadBuffer bufSrc, int ofSrc, int cbSrc)
For purposes of side-effects and potential exceptions, this method is functionally equivalent to the following code:
byte[] abSrc = bufSrc.toByteArray(ofSrc, cbSrc);
write(ofDest, abSrc, 0, abSrc.length);
write
in interface WriteBuffer
write
in class AbstractWriteBuffer
ofDest
- the offset within this buffer to store the passed databufSrc
- the array of bytes to store in this bufferofSrc
- the offset within the passed ReadBuffer to copy fromcbSrc
- the number of bytes to copy from the passed ReadBufferpublic int length()
length
in interface WriteBuffer
length
in class AbstractWriteBuffer
public void retain(int of, int cb)
AbstractWriteBuffer.length()
method will
be equal to cb.
Legal values for the offset of the first byte to retain of are
(of >= 0 && of <= AbstractWriteBuffer.length()
). Legal values for the
number of bytes to retain cb are
(cb >= 0 && cb <= AbstractWriteBuffer.length()
), such that
(of + cb <= AbstractWriteBuffer.length()
).
If cb is zero, then this method will have the same effect as clear. If of is zero, then this method will have the effect of truncating the data in the buffer, but no bytes will be shifted within the buffer.
The effect on the capacity of the buffer is implementation-specific; some implementations are expected to retain the same capacity while others are expected to shrink accordingly.
retain
in interface WriteBuffer
retain
in class AbstractWriteBuffer
of
- the offset of the first byte within the WriteBuffer that
will be retainedcb
- the number of bytes to retainpublic int getCapacity()
AbstractWriteBuffer.length()
bytes that can be written to it without
overflowing the current underlying buffer allocation. Since the buffer
is an abstract concept, the actual mechanism for the underlying buffer
is not known, but it could be a Java NIO buffer, or a byte array, etc.
Note that if the maximum size returned by AbstractWriteBuffer.getMaximumCapacity()
is greater than the current size returned by this method, then the
WriteBuffer will automatically resize itself to allocate more space
when the amount of data written to it passes the current size.
getCapacity
in interface WriteBuffer
getCapacity
in class AbstractWriteBuffer
public WriteBuffer.BufferOutput getBufferOutput(int of)
Note that each call to this method will return a new BufferOutput object, with the possible exception being that a zero-length non-resizing WriteBuffer could always return the same instance (since it is not writable).
This is functionally equivalent to:
BufferOutput bufout = getBufferOutput();
bufout.setOffset(of);
return bufout;
getBufferOutput
in interface WriteBuffer
getBufferOutput
in class AbstractWriteBuffer
of
- the offset of the first byte of this buffer that the
BufferOutput will write to
public ReadBuffer getReadBuffer()
This method is functionally equivalent to the following code:
ReadBuffer buf = getUnsafeReadBuffer();
byte[] ab = buf.toByteArray();
return new ByteArrayReadBuffer(ab);
getReadBuffer
in interface WriteBuffer
getReadBuffer
in class AbstractWriteBuffer
public ReadBuffer getUnsafeReadBuffer()
To get a snapshot, use the AbstractWriteBuffer.getReadBuffer()
method.
getUnsafeReadBuffer
in interface WriteBuffer
getUnsafeReadBuffer
in class AbstractWriteBuffer
public byte[] toByteArray()
This method is functionally equivalent to the following code:
return getUnsafeReadBuffer().toByteArray();
toByteArray
in interface WriteBuffer
toByteArray
in class AbstractWriteBuffer
public Binary toBinary()
This method is functionally equivalent to the following code:
return getUnsafeReadBuffer().toBinary();
toBinary
in interface WriteBuffer
toBinary
in class AbstractWriteBuffer
public Object clone()
clone
in interface WriteBuffer
clone
in class AbstractWriteBuffer
|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |