DefaultDataBuffer

java.lang.Object
- org.springframework.core.io.buffer.DefaultDataBuffer

All Implemented Interfaces:

DataBuffer

Direct Known Subclasses:

DefaultDataBuffer.SlicedDefaultDataBuffer
```
public class DefaultDataBuffer
extends java.lang.Object
implements DataBuffer
```
Default implementation of the DataBuffer interface that uses a ByteBuffer internally. with separate read and write positions. Constructed using the DefaultDataBufferFactory.
Inspired by Netty's ByteBuf. Introduced so that non-Netty runtimes (i.e. Servlet) do not require Netty on the classpath.

Since:

5.0

Author:

Arjen Poutsma, Juergen Hoeller, Brian Clozel

See Also:

DefaultDataBufferFactory

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`DefaultDataBuffer.DefaultDataBufferInputStream`
`private class`	`DefaultDataBuffer.DefaultDataBufferOutputStream`
`private static class`	`DefaultDataBuffer.SlicedDefaultDataBuffer`

Field Summary

Fields
Modifier and Type	Field and Description
`private java.nio.ByteBuffer`	`byteBuffer`
`private int`	`capacity`
`private static int`	`CAPACITY_THRESHOLD`
`private DefaultDataBufferFactory`	`dataBufferFactory`
`private static int`	`MAX_CAPACITY`
`private int`	`readPosition`
`private int`	`writePosition`

Constructor Summary

Constructors
Modifier Constructor and Description

private DefaultDataBuffer(DefaultDataBufferFactory dataBufferFactory, java.nio.ByteBuffer byteBuffer)

Constructors
Modifier	Constructor and Description
`private`	`DefaultDataBuffer(DefaultDataBufferFactory dataBufferFactory, java.nio.ByteBuffer byteBuffer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static java.nio.ByteBuffer`	`allocate(int capacity, boolean direct)`
`java.nio.ByteBuffer`	`asByteBuffer()` Expose this buffer's bytes as a `ByteBuffer`.
`java.nio.ByteBuffer`	`asByteBuffer(int index, int length)` Expose a subsequence of this buffer's bytes as a `ByteBuffer`.
`java.io.InputStream`	`asInputStream()` Expose this buffer's data as an `InputStream`.
`java.io.InputStream`	`asInputStream(boolean releaseOnClose)` Expose this buffer's data as an `InputStream`.
`java.io.OutputStream`	`asOutputStream()` Expose this buffer's data as an `OutputStream`.
`private void`	`assertIndex(boolean expression, java.lang.String format, java.lang.Object... args)`
`private int`	`calculateCapacity(int neededCapacity)` Calculate the capacity of the buffer.
`int`	`capacity()` Return the number of bytes that this buffer can contain.
`DefaultDataBuffer`	`capacity(int newCapacity)` Set the number of bytes that this buffer can contain.
`private void`	`checkIndex(int index, int length)`
`DataBuffer`	`ensureCapacity(int length)` Ensure that the current buffer has enough `DataBuffer.writableByteCount()` to write the amount of data given as an argument.
`boolean`	`equals(java.lang.Object other)`
`DefaultDataBufferFactory`	`factory()` Return the `DataBufferFactory` that created this buffer.
`(package private) static DefaultDataBuffer`	`fromEmptyByteBuffer(DefaultDataBufferFactory dataBufferFactory, java.nio.ByteBuffer byteBuffer)`
`(package private) static DefaultDataBuffer`	`fromFilledByteBuffer(DefaultDataBufferFactory dataBufferFactory, java.nio.ByteBuffer byteBuffer)`
`byte`	`getByte(int index)` Read a single byte at the given index from this data buffer.
`java.nio.ByteBuffer`	`getNativeBuffer()` Directly exposes the native `ByteBuffer` that this buffer is based on.
`int`	`hashCode()`
`int`	`indexOf(java.util.function.IntPredicate predicate, int fromIndex)` Return the index of the first byte in this buffer that matches the given predicate.
`int`	`lastIndexOf(java.util.function.IntPredicate predicate, int fromIndex)` Return the index of the last byte in this buffer that matches the given predicate.
`byte`	`read()` Read a single byte from the current reading position from this data buffer.
`DefaultDataBuffer`	`read(byte[] destination)` Read this buffer's data into the specified destination, starting at the current reading position of this buffer.
`DefaultDataBuffer`	`read(byte[] destination, int offset, int length)` Read at most `length` bytes of this buffer into the specified destination, starting at the current reading position of this buffer.
`int`	`readableByteCount()` Return the number of bytes that can be read from this data buffer.
`int`	`readPosition()` Return the position from which this buffer will read.
`DefaultDataBuffer`	`readPosition(int readPosition)` Set the position from which this buffer will read.
`private void`	`setNativeBuffer(java.nio.ByteBuffer byteBuffer)`
`DefaultDataBuffer`	`slice(int index, int length)` Create a new `DataBuffer` whose contents is a shared subsequence of this data buffer's content.
`java.lang.String`	`toString()`
`int`	`writableByteCount()` Return the number of bytes that can be written to this data buffer.
`DefaultDataBuffer`	`write(byte b)` Write a single byte into this buffer at the current writing position.
`DefaultDataBuffer`	`write(byte[] source)` Write the given source into this buffer, starting at the current writing position of this buffer.
`DefaultDataBuffer`	`write(byte[] source, int offset, int length)` Write at most `length` bytes of the given source into this buffer, starting at the current writing position of this buffer.
`DefaultDataBuffer`	`write(java.nio.ByteBuffer... buffers)` Write one or more `ByteBuffer` to this buffer, starting at the current writing position.
`private void`	`write(java.nio.ByteBuffer source)`
`DefaultDataBuffer`	`write(DataBuffer... buffers)` Write one or more `DataBuffer`s to this buffer, starting at the current writing position.
`int`	`writePosition()` Return the position to which this buffer will write.
`DefaultDataBuffer`	`writePosition(int writePosition)` Set the position to which this buffer will write.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.core.io.buffer.DataBuffer
write

- Field Detail
  - MAX_CAPACITY
```
private static final int MAX_CAPACITY
```
    See Also:
    
    Constant Field Values
  - CAPACITY_THRESHOLD
```
private static final int CAPACITY_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - dataBufferFactory
```
private final DefaultDataBufferFactory dataBufferFactory
```
  - byteBuffer
```
private java.nio.ByteBuffer byteBuffer
```
  - capacity
```
private int capacity
```
  - readPosition
```
private int readPosition
```
  - writePosition
```
private int writePosition
```
- Constructor Detail
  - DefaultDataBuffer
```
private DefaultDataBuffer(DefaultDataBufferFactory dataBufferFactory,
                          java.nio.ByteBuffer byteBuffer)
```
- Method Detail
  - fromFilledByteBuffer
```
static DefaultDataBuffer fromFilledByteBuffer(DefaultDataBufferFactory dataBufferFactory,
                                              java.nio.ByteBuffer byteBuffer)
```
  - fromEmptyByteBuffer
```
static DefaultDataBuffer fromEmptyByteBuffer(DefaultDataBufferFactory dataBufferFactory,
                                             java.nio.ByteBuffer byteBuffer)
```
  - getNativeBuffer
```
public java.nio.ByteBuffer getNativeBuffer()
```
    Directly exposes the native ByteBuffer that this buffer is based on.
    
    Returns:
    
    the wrapped byte buffer
  - setNativeBuffer
```
private void setNativeBuffer(java.nio.ByteBuffer byteBuffer)
```
  - factory
```
public DefaultDataBufferFactory factory()
```
    Description copied from interface: DataBuffer
    
    Return the DataBufferFactory that created this buffer.
    
    Specified by:
    
    factory in interface DataBuffer
    
    Returns:
    
    the creating buffer factory
  - indexOf
```
public int indexOf(java.util.function.IntPredicate predicate,
                   int fromIndex)
```
    Description copied from interface: DataBuffer
    
    Return the index of the first byte in this buffer that matches the given predicate.
    
    Specified by:
    
    indexOf in interface DataBuffer
    
    Parameters:
    
    predicate - the predicate to match
    
    fromIndex - the index to start the search from
    
    Returns:
    
    the index of the first byte that matches predicate; or -1 if none match
  - lastIndexOf
```
public int lastIndexOf(java.util.function.IntPredicate predicate,
                       int fromIndex)
```
    Description copied from interface: DataBuffer
    
    Return the index of the last byte in this buffer that matches the given predicate.
    
    Specified by:
    
    lastIndexOf in interface DataBuffer
    
    Parameters:
    
    predicate - the predicate to match
    
    fromIndex - the index to start the search from
    
    Returns:
    
    the index of the last byte that matches predicate; or -1 if none match
  - readableByteCount
```
public int readableByteCount()
```
    Description copied from interface: DataBuffer
    
    Return the number of bytes that can be read from this data buffer.
    
    Specified by:
    
    readableByteCount in interface DataBuffer
    
    Returns:
    
    the readable byte count
  - writableByteCount
```
public int writableByteCount()
```
    Description copied from interface: DataBuffer
    
    Return the number of bytes that can be written to this data buffer.
    
    Specified by:
    
    writableByteCount in interface DataBuffer
    
    Returns:
    
    the writable byte count
  - readPosition
```
public int readPosition()
```
    Description copied from interface: DataBuffer
    
    Return the position from which this buffer will read.
    
    Specified by:
    
    readPosition in interface DataBuffer
    
    Returns:
    
    the read position
  - readPosition
```
public DefaultDataBuffer readPosition(int readPosition)
```
    Description copied from interface: DataBuffer
    
    Set the position from which this buffer will read.
    
    Specified by:
    
    readPosition in interface DataBuffer
    
    Parameters:
    
    readPosition - the new read position
    
    Returns:
    
    this buffer
  - writePosition
```
public int writePosition()
```
    Description copied from interface: DataBuffer
    
    Return the position to which this buffer will write.
    
    Specified by:
    
    writePosition in interface DataBuffer
    
    Returns:
    
    the write position
  - writePosition
```
public DefaultDataBuffer writePosition(int writePosition)
```
    Description copied from interface: DataBuffer
    
    Set the position to which this buffer will write.
    
    Specified by:
    
    writePosition in interface DataBuffer
    
    Parameters:
    
    writePosition - the new write position
    
    Returns:
    
    this buffer
  - capacity
```
public int capacity()
```
    Description copied from interface: DataBuffer
    
    Return the number of bytes that this buffer can contain.
    
    Specified by:
    
    capacity in interface DataBuffer
    
    Returns:
    
    the capacity
  - capacity
```
public DefaultDataBuffer capacity(int newCapacity)
```
    Description copied from interface: DataBuffer
    
    Set the number of bytes that this buffer can contain.
    If the new capacity is lower than the current capacity, the contents of this buffer will be truncated. If the new capacity is higher than the current capacity, it will be expanded.
    
    Specified by:
    
    capacity in interface DataBuffer
    
    Parameters:
    
    newCapacity - the new capacity
    
    Returns:
    
    this buffer
  - ensureCapacity
```
public DataBuffer ensureCapacity(int length)
```
    Description copied from interface: DataBuffer
    
    Ensure that the current buffer has enough DataBuffer.writableByteCount() to write the amount of data given as an argument. If not, the missing capacity will be added to the buffer.
    
    Specified by:
    
    ensureCapacity in interface DataBuffer
    
    Parameters:
    
    length - the writable capacity to check for
    
    Returns:
    
    this buffer
  - allocate
```
private static java.nio.ByteBuffer allocate(int capacity,
                                            boolean direct)
```
  - getByte
```
public byte getByte(int index)
```
    Description copied from interface: DataBuffer
    
    Read a single byte at the given index from this data buffer.
    
    Specified by:
    
    getByte in interface DataBuffer
    
    Parameters:
    
    index - the index at which the byte will be read
    
    Returns:
    
    the byte at the given index
  - read
```
public byte read()
```
    Description copied from interface: DataBuffer
    
    Read a single byte from the current reading position from this data buffer.
    
    Specified by:
    
    read in interface DataBuffer
    
    Returns:
    
    the byte at this buffer's current reading position
  - read
```
public DefaultDataBuffer read(byte[] destination)
```
    Description copied from interface: DataBuffer
    
    Read this buffer's data into the specified destination, starting at the current reading position of this buffer.
    
    Specified by:
    
    read in interface DataBuffer
    
    Parameters:
    
    destination - the array into which the bytes are to be written
    
    Returns:
    
    this buffer
  - read
```
public DefaultDataBuffer read(byte[] destination,
                              int offset,
                              int length)
```
    Description copied from interface: DataBuffer
    
    Read at most length bytes of this buffer into the specified destination, starting at the current reading position of this buffer.
    
    Specified by:
    
    read in interface DataBuffer
    
    Parameters:
    
    destination - the array into which the bytes are to be written
    
    offset - the index within destination of the first byte to be written
    
    length - the maximum number of bytes to be written in destination
    
    Returns:
    
    this buffer
  - write
```
public DefaultDataBuffer write(byte b)
```
    Description copied from interface: DataBuffer
    
    Write a single byte into this buffer at the current writing position.
    
    Specified by:
    
    write in interface DataBuffer
    
    Parameters:
    
    b - the byte to be written
    
    Returns:
    
    this buffer
  - write
```
public DefaultDataBuffer write(byte[] source)
```
    Description copied from interface: DataBuffer
    
    Write the given source into this buffer, starting at the current writing position of this buffer.
    
    Specified by:
    
    write in interface DataBuffer
    
    Parameters:
    
    source - the bytes to be written into this buffer
    
    Returns:
    
    this buffer
  - write
```
public DefaultDataBuffer write(byte[] source,
                               int offset,
                               int length)
```
    Description copied from interface: DataBuffer
    
    Write at most length bytes of the given source into this buffer, starting at the current writing position of this buffer.
    
    Specified by:
    
    write in interface DataBuffer
    
    Parameters:
    
    source - the bytes to be written into this buffer
    
    offset - the index within source to start writing from
    
    length - the maximum number of bytes to be written from source
    
    Returns:
    
    this buffer
  - write
```
public DefaultDataBuffer write(DataBuffer... buffers)
```
    Description copied from interface: DataBuffer
    
    Write one or more DataBuffers to this buffer, starting at the current writing position. It is the responsibility of the caller to release the given data buffers.
    
    Specified by:
    
    write in interface DataBuffer
    
    Parameters:
    
    buffers - the byte buffers to write into this buffer
    
    Returns:
    
    this buffer
  - write
```
public DefaultDataBuffer write(java.nio.ByteBuffer... buffers)
```
    Description copied from interface: DataBuffer
    
    Write one or more ByteBuffer to this buffer, starting at the current writing position.
    
    Specified by:
    
    write in interface DataBuffer
    
    Parameters:
    
    buffers - the byte buffers to write into this buffer
    
    Returns:
    
    this buffer
  - write
```
private void write(java.nio.ByteBuffer source)
```
  - slice
```
public DefaultDataBuffer slice(int index,
                               int length)
```
    Description copied from interface: DataBuffer
    
    Create a new DataBuffer whose contents is a shared subsequence of this data buffer's content. Data between this data buffer and the returned buffer is shared; though changes in the returned buffer's position will not be reflected in the reading nor writing position of this data buffer.
    Note that this method will not call DataBufferUtils.retain(DataBuffer) on the resulting slice: the reference count will not be increased.
    
    Specified by:
    
    slice in interface DataBuffer
    
    Parameters:
    
    index - the index at which to start the slice
    
    length - the length of the slice
    
    Returns:
    
    the specified slice of this data buffer
  - asByteBuffer
```
public java.nio.ByteBuffer asByteBuffer()
```
    Description copied from interface: DataBuffer
    
    Expose this buffer's bytes as a ByteBuffer. Data between this DataBuffer and the returned ByteBuffer is shared; though changes in the returned buffer's position will not be reflected in the reading nor writing position of this data buffer.
    
    Specified by:
    
    asByteBuffer in interface DataBuffer
    
    Returns:
    
    this data buffer as a byte buffer
  - asByteBuffer
```
public java.nio.ByteBuffer asByteBuffer(int index,
                                        int length)
```
    Description copied from interface: DataBuffer
    
    Expose a subsequence of this buffer's bytes as a ByteBuffer. Data between this DataBuffer and the returned ByteBuffer is shared; though changes in the returned buffer's position will not be reflected in the reading nor writing position of this data buffer.
    
    Specified by:
    
    asByteBuffer in interface DataBuffer
    
    Parameters:
    
    index - the index at which to start the byte buffer
    
    length - the length of the returned byte buffer
    
    Returns:
    
    this data buffer as a byte buffer
  - asInputStream
```
public java.io.InputStream asInputStream()
```
    Description copied from interface: DataBuffer
    
    Expose this buffer's data as an InputStream. Both data and read position are shared between the returned stream and this data buffer. The underlying buffer will not be released when the input stream is closed.
    
    Specified by:
    
    asInputStream in interface DataBuffer
    
    Returns:
    
    this data buffer as an input stream
    
    See Also:
    
    DataBuffer.asInputStream(boolean)
  - asInputStream
```
public java.io.InputStream asInputStream(boolean releaseOnClose)
```
    Description copied from interface: DataBuffer
    
    Expose this buffer's data as an InputStream. Both data and read position are shared between the returned stream and this data buffer.
    
    Specified by:
    
    asInputStream in interface DataBuffer
    
    Parameters:
    
    releaseOnClose - whether the underlying buffer will be released when the input stream is closed.
    
    Returns:
    
    this data buffer as an input stream
  - asOutputStream
```
public java.io.OutputStream asOutputStream()
```
    Description copied from interface: DataBuffer
    
    Expose this buffer's data as an OutputStream. Both data and write position are shared between the returned stream and this data buffer.
    
    Specified by:
    
    asOutputStream in interface DataBuffer
    
    Returns:
    
    this data buffer as an output stream
  - calculateCapacity
```
private int calculateCapacity(int neededCapacity)
```
    Calculate the capacity of the buffer.
    
    See Also:
    
    io.netty.buffer.AbstractByteBufAllocator#calculateNewCapacity(int, int)
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - checkIndex
```
private void checkIndex(int index,
                        int length)
```
  - assertIndex
```
private void assertIndex(boolean expression,
                         java.lang.String format,
                         java.lang.Object... args)
```

Class DefaultDataBuffer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.core.io.buffer.DataBuffer

Field Detail

MAX_CAPACITY

CAPACITY_THRESHOLD

dataBufferFactory

byteBuffer

capacity

readPosition

writePosition

Constructor Detail

DefaultDataBuffer

Method Detail

fromFilledByteBuffer

fromEmptyByteBuffer

getNativeBuffer

setNativeBuffer

factory

indexOf

lastIndexOf

readableByteCount

writableByteCount

readPosition

readPosition

writePosition

writePosition

capacity

capacity

ensureCapacity

allocate

getByte

read

read

read

write

write

write

write

write

write

slice

asByteBuffer

asByteBuffer

asInputStream

asInputStream

asOutputStream

calculateCapacity

equals

hashCode

toString

checkIndex

assertIndex