public class ByteArrayWriteBuffer extends AbstractWriteBuffer
This implementation is not intended to be thread safe.
Modifier and Type | Class and Description |
---|---|
static class |
ByteArrayWriteBuffer.Allocator
Allocator is a WriteBufferPool implementation which allocates a new ByteArrayWriteBuffer on each request to the pool, and does not retain the returned buffer.
|
class |
ByteArrayWriteBuffer.ByteArrayBufferOutput
ByteArrayBufferOutput is an implementation of BufferOutput optimized for writing to the buffer's underlying byte array.
|
AbstractWriteBuffer.AbstractBufferOutput
WriteBuffer.BufferOutput
Modifier and Type | Field and Description |
---|---|
protected byte[] |
m_ab
The byte array that holds the binary data.
|
protected ByteArrayReadBuffer |
m_bufUnsafe
Cached ReadBuffer to quickly provide an answer to
getUnsafeReadBuffer() . |
protected int |
m_cb
Number of bytes in the byte array that have been written by this WriteBuffer.
|
protected int |
m_cbMax
Number of bytes that the byte array can be grown to.
|
CHAR_BUF_MASK, CHAR_BUF_SIZE, m_achBuf, NO_BINARY, NO_BYTES
Modifier | Constructor and Description |
---|---|
protected |
ByteArrayWriteBuffer()
Default constructor; intended only for use by subclasses.
|
|
ByteArrayWriteBuffer(byte[] ab)
Construct a ByteArrayWriteBuffer on a byte array.
|
|
ByteArrayWriteBuffer(int cbCap)
Construct an ByteArrayWriteBuffer with a certain initial capacity.
|
|
ByteArrayWriteBuffer(int cbCap, int cbMax)
Construct an ByteArrayWriteBuffer with a certain initial capacity and a certain maximum capacity.
|
|
ByteArrayWriteBuffer(WriteBuffer buffer, int i, int cb)
Create a new ByteArrayWriteBuffer based on a region of an already existing WriteBuffer.
|
Modifier and Type | Method and Description |
---|---|
protected void |
checkBounds(int of, int cb)
Validate the ranges for the passed bounds and make sure that the underlying array is big enough to handle them.
|
protected int |
copyStream(int ofDest, InputStreaming stream, int cbMax)
Store the remaining contents of the specified InputStreaming object at the specified offset within this buffer.
|
WriteBuffer.BufferOutput |
getBufferOutput(int of)
Get a BufferOutput object to write data to this buffer starting at a particular offset.
|
int |
getCapacity()
Determine the number of bytes that the buffer can hold without resizing itself.
|
int |
getMaximumCapacity()
Determine the maximum number of bytes that the buffer can hold.
|
byte[] |
getRawByteArray()
Obtain the byte array that this WriteBuffer uses.
|
ReadBuffer |
getUnsafeReadBuffer()
Get a ReadBuffer object to read data from this buffer.
|
protected void |
grow(int cbCap)
Grow the underlying byte array to at least the specified size.
|
boolean |
isByteArrayPrivate()
Determine if the underlying byte[] should be treated as private data.
|
int |
length()
Determine the length of the data that is in the buffer.
|
void |
makeByteArrayPrivate()
Make sure that the underlying byte[] will be treated as private data.
|
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.
|
void |
setLength(int cb)
Reconfigure the length of the buffer.
|
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.
|
protected void |
updateLength(int cb)
Update the length if the passed length is greater than the current buffer length.
|
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, InputStreaming stream, int cbSrc)
Store the specified number of bytes from the specified InputStreaming object 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, clone, copyBufferInputPortion, copyBufferInputRemainder, getAppendingBufferOutput, getBufferOutput, getReadBuffer, getWriteBuffer, getWriteBuffer, releaseBuffers, retain, tmpbuf, tmpbuf, write, write, write
protected byte[] m_ab
protected int m_cb
protected int m_cbMax
protected transient ByteArrayReadBuffer m_bufUnsafe
getUnsafeReadBuffer()
.protected ByteArrayWriteBuffer()
Note that this default constructor leaves the buffer in an invalid state.
public ByteArrayWriteBuffer(byte[] ab)
ab
- a byte arrayNullPointerException
- if ab is nullpublic ByteArrayWriteBuffer(int cbCap)
cbCap
- initial capacityIllegalArgumentException
- if cbCap is negativepublic ByteArrayWriteBuffer(int cbCap, int cbMax)
cbCap
- initial capacitycbMax
- maximum capacityIllegalArgumentException
- if cbCap or cbMax is negative, or if cbCap is greater than cbMaxpublic ByteArrayWriteBuffer(WriteBuffer buffer, int i, int cb)
buffer
- the source bufferi
- the offset within the source buffercb
- the number of bytes to copypublic final 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 final 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 final 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 final void write(int ofDest, InputStreaming stream, int cbSrc) throws IOException
For purposes of side-effects and potential exceptions, this method is functionally similar to the following code:
DataInputStream streamData = new DataInputStream(
new WrapperInputStream(stream));
byte[] abSrc = new byte[cbSrc];
streamData.readFully(abSrc);
write(ofDest, abSrc, 0, abSrc.length);
write
in interface WriteBuffer
write
in class AbstractWriteBuffer
ofDest
- the offset within this buffer to store the passed datastream
- the stream of bytes to read and store in this buffercbSrc
- the exact number of bytes to read from the stream and put in this bufferIOException
- if an IOException occurs reading from the passed streampublic final int length()
length
in interface WriteBuffer
length
in class AbstractWriteBuffer
public final void setLength(int cb)
cb
- the new length of the bufferpublic final 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 final 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 final int getMaximumCapacity()
getMaximumCapacity
in interface WriteBuffer
getMaximumCapacity
in class AbstractWriteBuffer
public final 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 final ReadBuffer getUnsafeReadBuffer()
To get a snapshot, use the WriteBuffer.getReadBuffer()
method.
getUnsafeReadBuffer
in interface WriteBuffer
getUnsafeReadBuffer
in class AbstractWriteBuffer
public final byte[] toByteArray()
This method is functionally equivalent to the following code:
return getUnsafeReadBuffer().toByteArray();
For efficiency purposes, it is possible to obtain the internal byte array that the ByteArrayWriteBuffer is using by calling getRawByteArray()
; if the internal byte array is private (i.e. if it cannot be exposed to the caller), then the result will be the same as would be returned by 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 boolean isByteArrayPrivate()
public final void makeByteArrayPrivate()
public final byte[] getRawByteArray()
toByteArray()
.protected final int copyStream(int ofDest, InputStreaming stream, int cbMax) throws IOException
copyStream
in class AbstractWriteBuffer
ofDest
- the offset within this buffer to store the passed datastream
- the stream of bytes to read and store in this buffercbMax
- the maximum number of bytes to copyIOException
- if an IOException occurs reading from the passed stream or if the limit is reached without emptying the source streamprotected void checkBounds(int of, int cb)
of
- the offset that data is about to be written tocb
- the length of the data that is about to be writtenprotected final void grow(int cbCap)
cbCap
- the required or requested capacityprotected final void updateLength(int cb)
cb
- the count of the last byte written (or the index of the next byte to write)