DefaultDataBuffer (Spring Framework 5.0.0.M5 API)

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

All Implemented Interfaces:

DataBuffer
```
public class DefaultDataBuffer
extends Object
implements DataBuffer
```
Default implementation of the DataBuffer interface that uses a ByteBuffer internally, with separate read and write positions. Constructed using the DefaultDataBufferFactory.

Since:

5.0

Author:

Arjen Poutsma

See Also:

DefaultDataBufferFactory

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteBuffer`	`asByteBuffer()` Expose this buffer's bytes as a `ByteBuffer`.
`InputStream`	`asInputStream()` Expose this buffer's data as an `InputStream`.
`OutputStream`	`asOutputStream()` Expose this buffer's data as an `OutputStream`.
`boolean`	`equals(Object obj)`
`DefaultDataBufferFactory`	`factory()` Return the `DataBufferFactory` that created this buffer.
`ByteBuffer`	`getNativeBuffer()` Directly exposes the native `ByteBuffer` that this buffer is based on.
`int`	`hashCode()`
`int`	`indexOf(IntPredicate predicate, int fromIndex)` Return the index of the first byte in this buffer that matches the given predicate.
`int`	`lastIndexOf(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 of 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.
`DataBuffer`	`slice(int index, int length)` Create a new `DataBuffer` whose contents is a shared subsequence of this data buffer's content.
`String`	`toString()`
`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, startin 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(ByteBuffer... byteBuffers)` Write one or more `ByteBuffer` to this buffer, starting at the current writing position.
`DataBuffer`	`write(DataBuffer... buffers)` Write one or more `DataBuffer`s to this buffer, starting at the current writing position.

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

- Method Detail
  - getNativeBuffer
```
public ByteBuffer getNativeBuffer()
```
    Directly exposes the native ByteBuffer that this buffer is based on.
    
    Returns:
    
    the wrapped byte buffer
  - 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(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(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
  - read
```
public byte read()
```
    Description copied from interface: DataBuffer
    
    Read a single byte from the current reading position of 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, startin 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 withing source to start writing from
    
    length - the maximum number of bytes to be written from source
    
    Returns:
    
    this buffer
  - write
```
public DataBuffer write(DataBuffer... buffers)
```
    Description copied from interface: DataBuffer
    
    Write one or more DataBuffers 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
```
public DefaultDataBuffer write(ByteBuffer... byteBuffers)
```
    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:
    
    byteBuffers - the byte buffers to write into this buffer
    
    Returns:
    
    this buffer
  - slice
```
public DataBuffer 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.
    
    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 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
  - asInputStream
```
public InputStream asInputStream()
```
    Description copied from interface: DataBuffer
    
    Expose this buffer's data as an InputStream. Both data and position are shared between the returned stream and this data buffer.
    
    Specified by:
    
    asInputStream in interface DataBuffer
    
    Returns:
    
    this data buffer as an input stream
  - asOutputStream
```
public OutputStream asOutputStream()
```
    Description copied from interface: DataBuffer
    
    Expose this buffer's data as an OutputStream. Both data and 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
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DefaultDataBuffer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getNativeBuffer

factory

indexOf

lastIndexOf

readableByteCount

read

read

read

write

write

write

write

write

slice

asByteBuffer

asInputStream

asOutputStream

equals

hashCode

toString