接口 DataBuffer

方法详细资料

• factory

  DataBufferFactory factory()

  Return the DataBufferFactory that created this buffer.

  返回:

  the creating buffer factory

• indexOf

  int indexOf​(IntPredicate predicate,
              int fromIndex)

  Return the index of the first byte in this buffer that matches the given predicate.

  参数:

  predicate - the predicate to match

  fromIndex - the index to start the search from

  返回:

  the index of the first byte that matches predicate; or -1 if none match

• lastIndexOf

  int lastIndexOf​(IntPredicate predicate,
                  int fromIndex)

  Return the index of the last byte in this buffer that matches the given predicate.

  参数:

  predicate - the predicate to match

  fromIndex - the index to start the search from

  返回:

  the index of the last byte that matches predicate; or -1 if none match

• readableByteCount

  int readableByteCount()

  Return the number of bytes that can be read from this data buffer.

  返回:

  the readable byte count

• writableByteCount

  int writableByteCount()

  Return the number of bytes that can be written to this data buffer.

  返回:

  the writable byte count

  从以下版本开始:

  5.0.1

• capacity

  int capacity()

  Return the number of bytes that this buffer can contain.

  返回:

  the capacity

  从以下版本开始:

  5.0.1

• capacity

  DataBuffer capacity​(int capacity)

  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.

  参数:

  capacity - the new capacity

  返回:

  this buffer

• ensureCapacity

  default DataBuffer ensureCapacity​(int capacity)

  Ensure that the current buffer has enough writableByteCount() to write the amount of data given as an argument. If not, the missing capacity will be added to the buffer.

  参数:

  capacity - the writable capacity to check for

  返回:

  this buffer

  从以下版本开始:

  5.1.4

• readPosition

  int readPosition()

  Return the position from which this buffer will read.

  返回:

  the read position

  从以下版本开始:

  5.0.1

• readPosition

  DataBuffer readPosition​(int readPosition)

  Set the position from which this buffer will read.

  参数:

  readPosition - the new read position

  返回:

  this buffer

  抛出:

  IndexOutOfBoundsException - if readPosition is smaller than 0 or greater than writePosition()

  从以下版本开始:

  5.0.1

• writePosition

  int writePosition()

  Return the position to which this buffer will write.

  返回:

  the write position

  从以下版本开始:

  5.0.1

• writePosition

  DataBuffer writePosition​(int writePosition)

  Set the position to which this buffer will write.

  参数:

  writePosition - the new write position

  返回:

  this buffer

  抛出:

  IndexOutOfBoundsException - if writePosition is smaller than readPosition() or greater than capacity()

  从以下版本开始:

  5.0.1

• getByte

  byte getByte​(int index)

  Read a single byte at the given index from this data buffer.

  参数:

  index - the index at which the byte will be read

  返回:

  the byte at the given index

  抛出:

  IndexOutOfBoundsException - when index is out of bounds

  从以下版本开始:

  5.0.4

• read

  byte read()

  Read a single byte from the current reading position from this data buffer.

  返回:

  the byte at this buffer's current reading position

• read

  DataBuffer read​(byte[] destination)

  Read this buffer's data into the specified destination, starting at the current reading position of this buffer.

  参数:

  destination - the array into which the bytes are to be written

  返回:

  this buffer

• read

  DataBuffer 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.

  参数:

  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

  返回:

  this buffer

• write

  DataBuffer write​(byte b)

  Write a single byte into this buffer at the current writing position.

  参数:

  b - the byte to be written

  返回:

  this buffer

• write

  DataBuffer write​(byte[] source)

  Write the given source into this buffer, starting at the current writing position of this buffer.

  参数:

  source - the bytes to be written into this buffer

  返回:

  this buffer

• write

  DataBuffer 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.

  参数:

  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

  返回:

  this buffer

• write

  DataBuffer write​(DataBuffer... buffers)

  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.

  参数:

  buffers - the byte buffers to write into this buffer

  返回:

  this buffer

• write

  DataBuffer write​(ByteBuffer... buffers)

  Write one or more ByteBuffer to this buffer, starting at the current writing position.

  参数:

  buffers - the byte buffers to write into this buffer

  返回:

  this buffer

• write

  default DataBuffer write​(CharSequence charSequence,
                           Charset charset)

  Write the given CharSequence using the given Charset, starting at the current writing position.

  参数:

  charSequence - the char sequence to write into this buffer

  charset - the charset to encode the char sequence with

  返回:

  this buffer

  从以下版本开始:

  5.1.4

• slice

  DataBuffer slice​(int index,
                   int length)

  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.

  参数:

  index - the index at which to start the slice

  length - the length of the slice

  返回:

  the specified slice of this data buffer

• retainedSlice

  default DataBuffer retainedSlice​(int index,
                                   int length)

  Create a new DataBuffer whose contents is a shared, retained 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 unlike slice(int, int), this method will call DataBufferUtils.retain(DataBuffer) (or equivalent) on the resulting slice.

  参数:

  index - the index at which to start the slice

  length - the length of the slice

  返回:

  the specified, retained slice of this data buffer

  从以下版本开始:

  5.2

• asByteBuffer

  ByteBuffer asByteBuffer()

  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.

  返回:

  this data buffer as a byte buffer

• asByteBuffer

  ByteBuffer asByteBuffer​(int index,
                          int length)

  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.

  参数:

  index - the index at which to start the byte buffer

  length - the length of the returned byte buffer

  返回:

  this data buffer as a byte buffer

  从以下版本开始:

  5.0.1

• asInputStream

  InputStream asInputStream()

  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.

  返回:

  this data buffer as an input stream

  另请参阅:

  asInputStream(boolean)

• asInputStream

  InputStream asInputStream​(boolean releaseOnClose)

  Expose this buffer's data as an InputStream. Both data and read position are shared between the returned stream and this data buffer.

  参数:

  releaseOnClose - whether the underlying buffer will be released when the input stream is closed.

  返回:

  this data buffer as an input stream

  从以下版本开始:

  5.0.4

• asOutputStream

  OutputStream asOutputStream()

  Expose this buffer's data as an OutputStream. Both data and write position are shared between the returned stream and this data buffer.

  返回:

  this data buffer as an output stream

• toString

  default String toString​(Charset charset)

  Return this buffer's data a String using the specified charset. Default implementation delegates to toString(readPosition(), readableByteCount(), charset).

  参数:

  charset - the character set to use

  返回:

  a string representation of all this buffers data

  从以下版本开始:

  5.2

• toString

  String toString​(int index,
                  int length,
                  Charset charset)

  Return a part of this buffer's data as a String using the specified charset.

  参数:

  index - the index at which to start the string

  length - the number of bytes to use for the string

  charset - the charset to use

  返回:

  a string representation of a part of this buffers data

  从以下版本开始:

  5.2