Class ArrayBuffer
java.lang.Object
org.simpleframework.common.buffer.ArrayBuffer
- All Implemented Interfaces:
Buffer
The
ArrayBuffer
is intended to be a general purpose
byte buffer that stores bytes in an single internal byte array. The
intended use of this buffer is to provide a simple buffer object to
read and write bytes with. In particular this provides a high
performance buffer that can be used to read and write bytes fast.
This provides several convenience methods which make the use of the
buffer easy and useful. This buffer allows an initial capacity to be
specified however if there is a need for extra space to be added to
buffer then the append
methods will expand the capacity
of the buffer as needed.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
ASegment
represents a segment within a buffer. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate byte[]
This is the internal array used to store the buffered bytes.private boolean
This is used to determine whether this buffer has been closed.private int
This is the count of the number of bytes buffered.private int
This is the maximum allowable buffer capacity for this. -
Constructor Summary
ConstructorsConstructorDescriptionConstructor for theArrayBuffer
object.ArrayBuffer
(int size) Constructor for theArrayBuffer
object.ArrayBuffer
(int size, int limit) Constructor for theArrayBuffer
object. -
Method Summary
Modifier and TypeMethodDescriptionallocate()
This method is used to allocate a segment of this buffer as a separate buffer object.append
(byte[] array) This method is used to append bytes to the end of the buffer.append
(byte[] array, int off, int size) This method is used to append bytes to the end of the buffer.void
clear()
This will clear all data from the buffer.void
close()
This method is used to ensure the buffer can be closed.encode()
This method is used to acquire the buffered bytes as a string.This method is used to acquire the buffered bytes as a string.private void
expand
(int capacity) This is used to ensure that there is enough space in the buffer to allow for more bytes to be added.long
length()
This is used to provide the number of bytes that have been written to the buffer.open()
This method is used so that the buffer can be represented as a stream of bytes.
-
Field Details
-
buffer
private byte[] bufferThis is the internal array used to store the buffered bytes. -
closed
private boolean closedThis is used to determine whether this buffer has been closed. -
count
private int countThis is the count of the number of bytes buffered. -
limit
private int limitThis is the maximum allowable buffer capacity for this.
-
-
Constructor Details
-
ArrayBuffer
public ArrayBuffer()Constructor for theArrayBuffer
object. The initial capacity of the default buffer object is set to 16, the capacity will be expanded when the append methods are used and there is not enough space to accommodate the extra bytes. -
ArrayBuffer
public ArrayBuffer(int size) Constructor for theArrayBuffer
object. The initial capacity of the buffer object is set to given size, the capacity will be expanded when the append methods are used and there is not enough space to accommodate the extra bytes.- Parameters:
size
- the initial capacity of this buffer instance
-
ArrayBuffer
public ArrayBuffer(int size, int limit) Constructor for theArrayBuffer
object. The initial capacity of the buffer object is set to given size, the capacity will be expanded when the append methods are used and there is not enough space to accommodate the extra bytes.- Parameters:
size
- the initial capacity of this buffer instancelimit
- this is the maximum allowable buffer capacity
-
-
Method Details
-
open
This method is used so that the buffer can be represented as a stream of bytes. This provides a quick means to access the data that has been written to the buffer. It wraps the buffer within an input stream so that it can be read directly. -
allocate
This method is used to allocate a segment of this buffer as a separate buffer object. This allows the buffer to be sliced in to several smaller independent buffers, while still allowing the parent buffer to manage a single buffer. This is useful if the parent is split in to logically smaller segments.- Specified by:
allocate
in interfaceBuffer
- Returns:
- this returns a buffer which is a segment of this buffer
- Throws:
IOException
-
encode
This method is used to acquire the buffered bytes as a string. This is useful if the contents need to be manipulated as a string or transferred into another encoding. If the UTF-8 content encoding is not supported the platform default is used, however this is unlikely as UTF-8 should be supported.- Specified by:
encode
in interfaceBuffer
- Returns:
- this returns a UTF-8 encoding of the buffer contents
- Throws:
IOException
-
encode
This method is used to acquire the buffered bytes as a string. This is useful if the contents need to be manipulated as a string or transferred into another encoding. This will convert the bytes using the specified character encoding format.- Specified by:
encode
in interfaceBuffer
- Parameters:
charset
- this is the charset to encode the data with- Returns:
- this returns the encoding of the buffer contents
- Throws:
IOException
-
append
This method is used to append bytes to the end of the buffer. This will expand the capacity of the buffer if there is not enough space to accommodate the extra bytes.- Specified by:
append
in interfaceBuffer
- Parameters:
array
- this is the byte array to append to this buffer- Returns:
- this returns this buffer for another operation
- Throws:
IOException
-
append
This method is used to append bytes to the end of the buffer. This will expand the capacity of the buffer if there is not enough space to accommodate the extra bytes.- Specified by:
append
in interfaceBuffer
- Parameters:
array
- this is the byte array to append to this bufferoff
- this is the offset to begin reading the bytes fromsize
- the number of bytes to be read from the array- Returns:
- this returns this buffer for another operation
- Throws:
IOException
-
expand
This is used to ensure that there is enough space in the buffer to allow for more bytes to be added. If the buffer is already larger than the required capacity the this will do nothing.- Parameters:
capacity
- the minimum size needed for this buffer object- Throws:
IOException
-
clear
This will clear all data from the buffer. This simply sets the count to be zero, it will not clear the memory occupied by the instance as the internal buffer will remain. This allows the memory occupied to be reused as many times as is required.- Specified by:
clear
in interfaceBuffer
- Throws:
IOException
-
close
This method is used to ensure the buffer can be closed. Once the buffer is closed it is an immutable collection of bytes and can not longer be modified. This ensures that it can be passed by value without the risk of modification of the bytes.- Specified by:
close
in interfaceBuffer
- Throws:
IOException
-
length
public long length()This is used to provide the number of bytes that have been written to the buffer. This increases as bytes are appended to the buffer. if the buffer is cleared this resets to zero.
-