public final class MultiBufferWriteBuffer extends AbstractWriteBuffer implements Disposable
Modifier and Type | Class and Description |
---|---|
class |
MultiBufferWriteBuffer.MultiBufferOutput
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 virtualizes 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.
|
static interface |
MultiBufferWriteBuffer.WriteBufferPool
A WriteBufferPool is used to dynamically allocate WriteBuffer objects as the MultiBufferWriteBuffer requires them.
|
AbstractWriteBuffer.AbstractBufferOutput
WriteBuffer.BufferOutput
CHAR_BUF_MASK, CHAR_BUF_SIZE, m_achBuf, NO_BINARY, NO_BYTES
Constructor and Description |
---|
MultiBufferWriteBuffer(MultiBufferWriteBuffer.WriteBufferPool bufferpool)
Construct a MultiBufferWriteBuffer that will use the passed WriteBufferPool to allocate WriteBuffer objects from.
|
MultiBufferWriteBuffer(MultiBufferWriteBuffer.WriteBufferPool bufferpool, int cbEstimate)
Construct a MultiBufferWriteBuffer that will use the passed WriteBufferPool to allocate WriteBuffer objects from.
|
Modifier and Type | Method and Description |
---|---|
protected WriteBuffer |
addBuffer()
Once the current buffer is full, allocate a new one and make it the current buffer.
|
Object |
clone()
Create a clone of this WriteBuffer object.
|
void |
dispose()
Invoked when all resources owned by the implementer can safely be released.
|
protected MultiBufferWriteBuffer.MultiBufferOutput |
ensureBufferOutput(int of)
Obtain the internal MultiBufferOutput, creating it if necessary.
|
WriteBuffer |
getBuffer(int iBuffer)
Obtain the specified buffer.
|
int |
getBufferCount()
Determine the number of WriteBuffer objects allocated by this MultiBufferWriteBuffer from the WriteBufferPool.
|
protected int |
getBufferIndexByOffset(int of)
Determine which underlying WriteBuffer contains the specified offset.
|
int |
getBufferOffset(int iBuffer)
Determine the offset of the specified buffer.
|
WriteBuffer.BufferOutput |
getBufferOutput(int of)
Get a BufferOutput object to write data to this buffer starting at a particular offset.
|
MultiBufferWriteBuffer.WriteBufferPool |
getBufferPool()
Obtain the factory used to create WriteBuffer objects.
|
int |
getCapacity()
Determine the number of bytes that the buffer can hold without resizing itself.
|
protected WriteBuffer |
getCurrentBuffer()
Obtain the current buffer.
|
protected int |
getCurrentBufferAbsoluteOffset()
Determine the offset of the first byte of the current buffer.
|
protected int |
getCurrentBufferRemaining()
Determine the maximum number of bytes that can still be written to the current underlying WriteBuffer.
|
int |
getMaximumCapacity()
Determine the maximum number of bytes that the buffer can hold.
|
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.
|
clear, copyBufferInputPortion, copyBufferInputRemainder, copyStream, getAppendingBufferOutput, getBufferOutput, getWriteBuffer, getWriteBuffer, releaseBuffers, retain, tmpbuf, tmpbuf, write, write, write, write
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close
public MultiBufferWriteBuffer(MultiBufferWriteBuffer.WriteBufferPool bufferpool)
bufferpool
- a MultiBufferWriteBuffer.WriteBufferPool
from which the MultiBufferWriteBuffer will allocate WriteBuffer objectspublic MultiBufferWriteBuffer(MultiBufferWriteBuffer.WriteBufferPool bufferpool, int cbEstimate)
bufferpool
- a MultiBufferWriteBuffer.WriteBufferPool
from which the MultiBufferWriteBuffer will allocate WriteBuffer objectscbEstimate
- an estimate as to the final sizepublic 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 WriteBuffer.length()
method will become Math.max(WriteBuffer.length()
, ofDest + cbSrc).
As a result of this method, the buffer capacity as reported by the WriteBuffer.getCapacity()
method will not change if the new value returned by WriteBuffer.length()
would not exceed the old value returned by WriteBuffer.getCapacity()
; otherwise, the capacity will be increased such that WriteBuffer.getCapacity()
>= WriteBuffer.length()
. Regardless, it is always true that WriteBuffer.getCapacity()
>= WriteBuffer.length()
and WriteBuffer.getMaximumCapacity()
>= WriteBuffer.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)
WriteBuffer.length()
method will be equal to cb.
Legal values for the offset of the first byte to retain of are (of >= 0 && of <= WriteBuffer.length()
). Legal values for the number of bytes to retain cb are (cb >= 0 && cb <= WriteBuffer.length()
), such that (of + cb <= WriteBuffer.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()
WriteBuffer.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 WriteBuffer.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 int getMaximumCapacity()
getMaximumCapacity
in interface WriteBuffer
getMaximumCapacity
in class AbstractWriteBuffer
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 WriteBuffer.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 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 topublic Object clone()
clone
in interface WriteBuffer
clone
in class AbstractWriteBuffer
public void dispose()
Once disposed of the object should no longer be considered to be usable.
Note the Disposable interface is compatible with try-with-resources which will automatically invoke this method.
dispose
in interface Disposable
public MultiBufferWriteBuffer.WriteBufferPool getBufferPool()
public int getBufferCount()
public int getBufferOffset(int iBuffer)
iBuffer
- an index 0 <= iBuffer < getBufferCount()public WriteBuffer getBuffer(int iBuffer)
iBuffer
- an index 0 <= iBuffer < getBufferCount()protected int getBufferIndexByOffset(int of)
of
- an offset into the MultiBufferWriteBuffer, 0 <= of <= length()protected WriteBuffer addBuffer()
protected WriteBuffer getCurrentBuffer()
protected int getCurrentBufferAbsoluteOffset()
protected int getCurrentBufferRemaining()
protected MultiBufferWriteBuffer.MultiBufferOutput ensureBufferOutput(int of)
of
- the desired offset of the MultiBufferOutput