Buffer (reactor-core 2.0.8.RELEASE API)

java.lang.Object
- reactor.io.buffer.Buffer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Comparable<Buffer>, java.lang.Iterable<java.lang.Byte>, java.nio.channels.Channel, java.nio.channels.ReadableByteChannel, java.nio.channels.WritableByteChannel, Recyclable
```
@NotThreadSafe
public class Buffer
extends java.lang.Object
implements Recyclable, java.lang.Comparable<Buffer>, java.lang.Iterable<java.lang.Byte>, java.nio.channels.ReadableByteChannel, java.nio.channels.WritableByteChannel
```
A Buffer is a general-purpose IO utility class that wraps a ByteBuffer. It provides optional dynamic expansion of the buffer to accommodate additional content. It also provides convenience methods for operating on buffers.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Buffer.View
A View represents a segment of a buffer.

Nested Classes
Modifier and Type	Class and Description
`class`	`Buffer.View` A View represents a segment of a buffer.

Field Summary

Fields
Modifier and Type	Field and Description
`static Buffer`	`DELIMITING_BUFFER` A delimiting buffer is sent to `BufferCodec` and other components to signal the end of a sequence of Buffer.
`static int`	`MAX_BUFFER_SIZE` The maximum allowed buffer size in bytes.
`static int`	`SMALL_BUFFER_SIZE` The size, in bytes, of a small buffer.

Constructor Summary

Constructors
Constructor and Description
`Buffer()` Create an empty Buffer that is dynamic.
`Buffer(Buffer bufferToCopy)` Copy constructor that creates a shallow copy of the given Buffer by calling `ByteBuffer.duplicate()` on the underlying `ByteBuffer`.
`Buffer(java.nio.ByteBuffer bufferToStartWith)` Create a Buffer using the given `ByteBuffer` as the inital source.
`Buffer(int atLeast, boolean fixed)` Create an Buffer that has an internal `ByteBuffer` allocated to the given size and optional make this buffer fixed-length.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Buffer`	`append(Buffer... buffers)` Append the given `Buffer` to this Buffer.
`Buffer`	`append(byte b)` Append the given `byte` to this Buffer.
`Buffer`	`append(byte[] b)` Append the given `byte[]` to this Buffer.
`Buffer`	`append(byte[] b, int start, int len)` Append the given `byte[]` to this Buffer, starting at the given index and continuing for the given length.
`Buffer`	`append(java.nio.ByteBuffer... buffers)` Append the given `ByteBuffer` to this Buffer.
`Buffer`	`append(char c)` Append the given `char` to this Buffer.
`Buffer`	`append(int i)` Append the given `int` to this Buffer.
`Buffer`	`append(long l)` Append the given `long` to this Buffer.
`Buffer`	`append(short s)` Append the given `short` to this Buffer.
`Buffer`	`append(java.lang.String s)` Append the given String to this Buffer.
`byte[]`	`asBytes()` Return the contents of this buffer copied into a `byte[]`.
`java.lang.String`	`asString()` Convert the contents of this buffer into a String using a UTF-8 `CharsetDecoder`.
`java.nio.ByteBuffer`	`byteBuffer()` Return the underlying `ByteBuffer`.
`int`	`capacity()` Provides the current capacity of the internal `ByteBuffer`.
`Buffer`	`clear()` Clear the internal `ByteBuffer` by setting the `Buffer.position(int)` to 0 and the limit to the current capacity.
`void`	`close()`
`Buffer`	`compact()` Compact the underlying `ByteBuffer`.
`int`	`compareTo(Buffer buffer)`
`Buffer`	`copy()` Create a new `Buffer` by copying the underlying `ByteBuffer` into a newly-allocated `Buffer`.
`Buffer.View`	`createView()` Create a `Buffer.View` of the current range of this `Buffer`.
`Buffer.View`	`createView(int start, int end)` Create a `Buffer.View` of the given range of this Buffer.
`Buffer`	`duplicate()` Create a new `Buffer` by calling `ByteBuffer.duplicate()` on the underlying `ByteBuffer`.
`byte`	`first()` Get the first `byte` from this Buffer.
`Buffer`	`flip()` Flip this Buffer.
`int`	`indexOf(byte b)` Search the buffer and find the position of the first occurrence of the given `byte`.
`int`	`indexOf(byte b, int start, int end)` Search the buffer and find the position of the first occurrence of the given `byte` staring at the start position and searching until (and including) the end position.
`java.io.InputStream`	`inputStream()` Create an `InputStream` capable of reading the bytes from the internal `ByteBuffer`.
`boolean`	`isDelimitingBuffer()` Is this instance a delimiting Buffer
`boolean`	`isDynamic()` Whether this Buffer is fixed-length or not.
`boolean`	`isOpen()`
`java.util.Iterator<java.lang.Byte>`	`iterator()`
`byte`	`last()` Get the last `byte` from this Buffer.
`int`	`limit()` Provides the current limit of the internal `ByteBuffer`.
`Buffer`	`limit(int limit)` Sets this buffer's limit.
`static java.lang.Integer`	`parseInt(Buffer b)` Very efficient method for parsing an `Integer` from the given Buffer.
`static java.lang.Integer`	`parseInt(Buffer b, int start, int end)` Very efficient method for parsing an `Integer` from the given Buffer range.
`static java.lang.Long`	`parseLong(Buffer b)` Very efficient method for parsing a `Long` from the given Buffer.
`static java.lang.Long`	`parseLong(Buffer b, int start, int end)` Very efficient method for parsing a `Long` from the given Buffer range.
`int`	`position()` Provides the current position in the internal `ByteBuffer`.
`Buffer`	`position(int pos)` Sets this buffer's position.
`Buffer`	`prepend(Buffer b)` Prepend the given `Buffer` to this Buffer.
`Buffer`	`prepend(byte b)` Prepend the given `byte` to this Buffer.
`Buffer`	`prepend(byte[] bytes)` Prepend the given `byte[]` array to this Buffer.
`Buffer`	`prepend(java.nio.ByteBuffer b)` Prepend the given `ByteBuffer` to this Buffer.
`Buffer`	`prepend(char c)` Prepend the given `char` to this existing Buffer.
`Buffer`	`prepend(int i)` Prepend the given `int` to this Buffer.
`Buffer`	`prepend(long l)` Prepend the given `long` to this Buffer.
`Buffer`	`prepend(short s)` Prepend the given `short` to this Buffer.
`Buffer`	`prepend(java.lang.String s)` Prepend the given `String` to this Buffer.
`byte`	`read()` Read a single `byte` from the underlying `ByteBuffer`.
`Buffer`	`read(byte[] b)` Read at least `b.length` bytes from the underlying `ByteBuffer`.
`int`	`read(java.nio.ByteBuffer dst)`
`char`	`readChar()` Read the next `char` from the underlying `ByteBuffer`.
`double`	`readDouble()` Read the next `double` from the underlying `ByteBuffer`.
`float`	`readFloat()` Read the next `float` from the underlying `ByteBuffer`.
`int`	`readInt()` Read the next `int` from the underlying `ByteBuffer`.
`long`	`readLong()` Read the next `long` from the underlying `ByteBuffer`.
`short`	`readShort()` Read the next `short` from the underlying `ByteBuffer`.
`void`	`recycle()` Free any internal resources and reset the state of the object to enable reuse.
`int`	`remaining()` How many bytes available in this Buffer.
`Buffer`	`reset()` Reset the buffer to the previously-saved position and limit.
`Buffer`	`rewind()` Rewind this Buffer to the beginning.
`Buffer`	`rewind(int len)` Rewinds this buffer by `len` bytes.
`Buffer`	`skip(int len)` Skips `len` bytes.
`java.util.List<Buffer.View>`	`slice(int... positions)` Slice this buffer at the given positions.
`Buffer`	`slice(int start, int len)` Create a copy of the given range.
`void`	`snapshot()` Save the current buffer position and limit.
`java.lang.Iterable<Buffer.View>`	`split(Buffer delimiter)` Split this buffer on the given delimiter and leave the delimiter on the end of each segment.
`java.lang.Iterable<Buffer.View>`	`split(Buffer delimiter, boolean stripDelimiter)` Split this buffer on the given delimiter.
`java.util.List<Buffer.View>`	`split(int delimiter)` Split this buffer on the given delimiter.
`java.util.List<Buffer.View>`	`split(int delimiter, boolean stripDelimiter)` Split this buffer on the given delimiter and optionally leave the delimiter intact rather than stripping it.
`java.lang.Iterable<Buffer.View>`	`split(java.util.List<Buffer.View> views, Buffer delimiter, boolean stripDelimiter)` Split this buffer on the given delimiter.
`java.util.List<Buffer.View>`	`split(java.util.List<Buffer.View> views, int delimiter)` Split this buffer on the given delimiter but save memory by reusing the given `List`.
`java.util.List<Buffer.View>`	`split(java.util.List<Buffer.View> views, int delimiter, boolean stripDelimiter)` Split this buffer on the given delimiter, save memory by reusing the given `List`, and optionally leave the delimiter intact rather than stripping it.
`java.lang.String`	`substring(int start, int end)` Slice a portion of this buffer and convert it to a String.
`java.lang.String`	`toString()`
`static Buffer`	`wrap(byte[] bytes)` Convenience method to create a new, fixed-length Buffer and putting the given byte array into the buffer.
`static Buffer`	`wrap(java.lang.String str)` Convenience method to create a new, fixed-length Buffer from the given String.
`static Buffer`	`wrap(java.lang.String str, boolean fixed)` Convenience method to create a new Buffer from the given String and optionally specify whether the new Buffer should be a fixed length or not.
`int`	`write(java.nio.ByteBuffer src)`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - SMALL_BUFFER_SIZE
```
public static int SMALL_BUFFER_SIZE
```
    The size, in bytes, of a small buffer. Can be configured using the reactor.io.defaultBufferSize system property. Default to 16384 bytes.
  - MAX_BUFFER_SIZE
```
public static int MAX_BUFFER_SIZE
```
    The maximum allowed buffer size in bytes. Can be configured using the reactor.io.maxBufferSize system property. Defaults to 16384000 bytes.
  - DELIMITING_BUFFER
```
public static final Buffer DELIMITING_BUFFER
```
    A delimiting buffer is sent to BufferCodec and other components to signal the end of a sequence of Buffer.
    
    Since:
    
    2.0.4
- Constructor Detail
  - Buffer
```
public Buffer()
```
    Create an empty Buffer that is dynamic.
  - Buffer
```
public Buffer(int atLeast,
              boolean fixed)
```
    Create an Buffer that has an internal ByteBuffer allocated to the given size and optional make this buffer fixed-length.
    
    Parameters:
    
    atLeast - Allocate this many bytes immediately.
    
    fixed - true to make this buffer fixed-length, false otherwise.
  - Buffer
```
public Buffer(Buffer bufferToCopy)
```
    Copy constructor that creates a shallow copy of the given Buffer by calling ByteBuffer.duplicate() on the underlying ByteBuffer.
    
    Parameters:
    
    bufferToCopy - The Buffer to copy.
  - Buffer
```
public Buffer(java.nio.ByteBuffer bufferToStartWith)
```
    Create a Buffer using the given ByteBuffer as the inital source.
    
    Parameters:
    
    bufferToStartWith - The ByteBuffer to start with.
- Method Detail
  - wrap
```
public static Buffer wrap(byte[] bytes)
```
    Convenience method to create a new, fixed-length Buffer and putting the given byte array into the buffer.
    
    Parameters:
    
    bytes - The bytes to create a buffer from.
    
    Returns:
    
    The new Buffer.
  - wrap
```
public static Buffer wrap(java.lang.String str,
                          boolean fixed)
```
    Convenience method to create a new Buffer from the given String and optionally specify whether the new Buffer should be a fixed length or not.
    
    Parameters:
    
    str - The String to create a buffer from.
    
    fixed - true to create a fixed-length Buffer, false otherwise.
    
    Returns:
    
    The new Buffer.
  - wrap
```
public static Buffer wrap(java.lang.String str)
```
    Convenience method to create a new, fixed-length Buffer from the given String.
    
    Parameters:
    
    str - The String to create a buffer from.
    
    Returns:
    
    The new fixed-length Buffer.
  - parseInt
```
public static java.lang.Integer parseInt(Buffer b,
                                         int start,
                                         int end)
```
    Very efficient method for parsing an Integer from the given Buffer range. Much faster than Integer.parseInt(String).
    
    Parameters:
    
    b - The Buffer to slice.
    
    start - start of the range.
    
    end - end of the range.
    
    Returns:
    
    The int value or null if the Buffer could not be read.
  - parseInt
```
public static java.lang.Integer parseInt(Buffer b)
```
    Very efficient method for parsing an Integer from the given Buffer. Much faster than Integer.parseInt(String).
    
    Parameters:
    
    b - The Buffer to slice.
    
    Returns:
    
    The int value or null if the Buffer could not be read.
  - parseLong
```
public static java.lang.Long parseLong(Buffer b,
                                       int start,
                                       int end)
```
    Very efficient method for parsing a Long from the given Buffer range. Much faster than Long.parseLong(String).
    
    Parameters:
    
    b - The Buffer to slice.
    
    start - start of the range.
    
    end - end of the range.
    
    Returns:
    
    The long value or null if the Buffer could not be read.
  - parseLong
```
public static java.lang.Long parseLong(Buffer b)
```
    Very efficient method for parsing a Long from the given Buffer. Much faster than Long.parseLong(String).
    
    Parameters:
    
    b - The Buffer to slice.
    
    Returns:
    
    The long value or null if the Buffer could not be read.
  - recycle
```
public void recycle()
```
    Description copied from interface: Recyclable
    
    Free any internal resources and reset the state of the object to enable reuse.
    
    Specified by:
    
    recycle in interface Recyclable
  - isDynamic
```
public final boolean isDynamic()
```
    Whether this Buffer is fixed-length or not.
    
    Returns:
    
    true if this Buffer is not fixed-length, false otherwise.
  - position
```
public final int position()
```
    Provides the current position in the internal ByteBuffer.
    
    Returns:
    
    The current position.
  - position
```
public Buffer position(int pos)
```
    Sets this buffer's position.
    
    Parameters:
    
    pos - the new position
    
    Returns:
    
    this buffer
  - limit
```
public Buffer limit(int limit)
```
    Sets this buffer's limit.
    
    Parameters:
    
    limit - the new limit
    
    Returns:
    
    this buffer
  - skip
```
public Buffer skip(int len)
```
    Skips len bytes.
    
    Parameters:
    
    len - the number of bytes to skip
    
    Returns:
    
    this buffer
    
    Throws:
    
    java.nio.BufferUnderflowException - if the skip exceeds the available bytes
    
    java.lang.IllegalArgumentException - if len is negative
  - limit
```
public int limit()
```
    Provides the current limit of the internal ByteBuffer.
    
    Returns:
    
    The current limit.
  - capacity
```
public int capacity()
```
    Provides the current capacity of the internal ByteBuffer.
    
    Returns:
    
    The current capacity.
  - remaining
```
public int remaining()
```
    How many bytes available in this Buffer. If reading, it is the number of bytes available to read. If writing, it is the number of bytes available for writing.
    
    Returns:
    
    The number of bytes available in this Buffer.
  - clear
```
public Buffer clear()
```
    Clear the internal ByteBuffer by setting the Buffer.position(int) to 0 and the limit to the current capacity.
    
    Returns:
    
    this
  - compact
```
public Buffer compact()
```
    Compact the underlying ByteBuffer.
    
    Returns:
    
    this
  - flip
```
public Buffer flip()
```
    Flip this Buffer. Used after a write to prepare this Buffer for reading.
    
    Returns:
    
    this
  - rewind
```
public Buffer rewind()
```
    Rewind this Buffer to the beginning. Prepares the Buffer for reuse.
    
    Returns:
    
    this
  - rewind
```
public Buffer rewind(int len)
```
    Rewinds this buffer by len bytes.
    
    Parameters:
    
    len - The number of bytes the rewind by
    
    Returns:
    
    this buffer
    
    Throws:
    
    java.nio.BufferUnderflowException - if the rewind would move past the start of the buffer
    
    java.lang.IllegalArgumentException - if len is negative
  - duplicate
```
public Buffer duplicate()
```
    Create a new Buffer by calling ByteBuffer.duplicate() on the underlying ByteBuffer.
    
    Returns:
    
    the new Buffer
  - copy
```
public Buffer copy()
```
    Create a new Buffer by copying the underlying ByteBuffer into a newly-allocated Buffer.
    
    Returns:
    
    the new Buffer
  - prepend
```
public Buffer prepend(Buffer b)
```
    Prepend the given Buffer to this Buffer.
    
    Parameters:
    
    b - The Buffer to prepend.
    
    Returns:
    
    this
  - prepend
```
public Buffer prepend(java.lang.String s)
```
    Prepend the given String to this Buffer.
    
    Parameters:
    
    s - The String to prepend.
    
    Returns:
    
    this
  - prepend
```
public Buffer prepend(byte[] bytes)
```
    Prepend the given byte[] array to this Buffer.
    
    Parameters:
    
    bytes - The byte[] to prepend.
    
    Returns:
    
    this
  - prepend
```
public Buffer prepend(java.nio.ByteBuffer b)
```
    Prepend the given ByteBuffer to this Buffer.
    
    Parameters:
    
    b - The ByteBuffer to prepend.
    
    Returns:
    
    this
  - prepend
```
public Buffer prepend(byte b)
```
    Prepend the given byte to this Buffer.
    
    Parameters:
    
    b - The byte to prepend.
    
    Returns:
    
    this
  - prepend
```
public Buffer prepend(char c)
```
    Prepend the given char to this existing Buffer.
    
    Parameters:
    
    c - The char to prepend.
    
    Returns:
    
    this
  - prepend
```
public Buffer prepend(short s)
```
    Prepend the given short to this Buffer.
    
    Parameters:
    
    s - The short to prepend.
    
    Returns:
    
    this
  - prepend
```
public Buffer prepend(int i)
```
    Prepend the given int to this Buffer.
    
    Parameters:
    
    i - The int to prepend.
    
    Returns:
    
    this
  - prepend
```
public Buffer prepend(long l)
```
    Prepend the given long to this Buffer.
    
    Parameters:
    
    l - The long to prepend.
    
    Returns:
    
    this
  - append
```
public Buffer append(java.lang.String s)
```
    Append the given String to this Buffer.
    
    Parameters:
    
    s - The String to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(short s)
```
    Append the given short to this Buffer.
    
    Parameters:
    
    s - The short to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(int i)
```
    Append the given int to this Buffer.
    
    Parameters:
    
    i - The int to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(long l)
```
    Append the given long to this Buffer.
    
    Parameters:
    
    l - The long to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(char c)
```
    Append the given char to this Buffer.
    
    Parameters:
    
    c - The char to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(java.nio.ByteBuffer... buffers)
```
    Append the given ByteBuffer to this Buffer.
    
    Parameters:
    
    buffers - The ByteBuffers to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(Buffer... buffers)
```
    Append the given Buffer to this Buffer.
    
    Parameters:
    
    buffers - The Buffers to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(byte b)
```
    Append the given byte to this Buffer.
    
    Parameters:
    
    b - The byte to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(byte[] b)
```
    Append the given byte[] to this Buffer.
    
    Parameters:
    
    b - The byte[] to append.
    
    Returns:
    
    this
  - append
```
public Buffer append(byte[] b,
                     int start,
                     int len)
```
    Append the given byte[] to this Buffer, starting at the given index and continuing for the given length.
    
    Parameters:
    
    b - the bytes to append
    
    start - the index of where to start copying bytes
    
    len - the len of the bytes to copy
    
    Returns:
    
    this
  - first
```
public byte first()
```
    Get the first byte from this Buffer.
    
    Returns:
    
    The first byte.
  - last
```
public byte last()
```
    Get the last byte from this Buffer.
    
    Returns:
    
    The last byte.
  - read
```
public byte read()
```
    Read a single byte from the underlying ByteBuffer.
    
    Returns:
    
    The next byte.
  - read
```
public Buffer read(byte[] b)
```
    Read at least b.length bytes from the underlying ByteBuffer.
    
    Parameters:
    
    b - The buffer to fill.
    
    Returns:
    
    this
  - readShort
```
public short readShort()
```
    Read the next short from the underlying ByteBuffer.
    
    Returns:
    
    The next short.
  - readInt
```
public int readInt()
```
    Read the next int from the underlying ByteBuffer.
    
    Returns:
    
    The next int.
  - readFloat
```
public float readFloat()
```
    Read the next float from the underlying ByteBuffer.
    
    Returns:
    
    The next float.
  - readDouble
```
public double readDouble()
```
    Read the next double from the underlying ByteBuffer.
    
    Returns:
    
    The next double.
  - readLong
```
public long readLong()
```
    Read the next long from the underlying ByteBuffer.
    
    Returns:
    
    The next long.
  - readChar
```
public char readChar()
```
    Read the next char from the underlying ByteBuffer.
    
    Returns:
    
    The next char.
  - snapshot
```
public void snapshot()
```
    Save the current buffer position and limit.
  - reset
```
public Buffer reset()
```
    Reset the buffer to the previously-saved position and limit.
    
    Returns:
    
    this
  - iterator
```
public java.util.Iterator<java.lang.Byte> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Byte>
  - read
```
public int read(java.nio.ByteBuffer dst)
         throws java.io.IOException
```
    Specified by:
    
    read in interface java.nio.channels.ReadableByteChannel
    
    Throws:
    
    java.io.IOException
  - write
```
public int write(java.nio.ByteBuffer src)
          throws java.io.IOException
```
    Specified by:
    
    write in interface java.nio.channels.WritableByteChannel
    
    Throws:
    
    java.io.IOException
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface java.nio.channels.Channel
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.nio.channels.Channel
    
    Throws:
    
    java.io.IOException
  - asString
```
public java.lang.String asString()
```
    Convert the contents of this buffer into a String using a UTF-8 CharsetDecoder.
    
    Returns:
    
    The contents of this Buffer as a String.
  - substring
```
public java.lang.String substring(int start,
                                  int end)
```
    Slice a portion of this buffer and convert it to a String.
    
    Parameters:
    
    start - start of the range.
    
    end - end of the range.
    
    Returns:
    
    The contents of the given range as a String.
  - asBytes
```
public byte[] asBytes()
```
    Return the contents of this buffer copied into a byte[].
    
    Returns:
    
    The contents of this buffer as a byte[].
  - inputStream
```
public java.io.InputStream inputStream()
```
    Create an InputStream capable of reading the bytes from the internal ByteBuffer.
    
    Returns:
    
    A new InputStream.
  - slice
```
public Buffer slice(int start,
                    int len)
```
    Create a copy of the given range.
    
    Parameters:
    
    start - start of the range.
    
    len - end of the range.
    
    Returns:
    
    A new Buffer, constructed from the contents of the given range.
  - split
```
public java.util.List<Buffer.View> split(int delimiter)
```
    Split this buffer on the given delimiter.
    
    Parameters:
    
    delimiter - The delimiter on which to split this buffer.
    
    Returns:
    
    A List of Views that point to the segments of this buffer.
  - split
```
public java.util.List<Buffer.View> split(java.util.List<Buffer.View> views,
                                         int delimiter)
```
    Split this buffer on the given delimiter but save memory by reusing the given List.
    
    Parameters:
    
    views - The list to store Views in.
    
    delimiter - The delimiter on which to split this buffer.
    
    Returns:
    
    A List of Views that point to the segments of this buffer.
  - split
```
public java.util.List<Buffer.View> split(int delimiter,
                                         boolean stripDelimiter)
```
    Split this buffer on the given delimiter and optionally leave the delimiter intact rather than stripping it.
    
    Parameters:
    
    delimiter - The delimiter on which to split this buffer.
    
    stripDelimiter - true to ignore the delimiter, false to leave it in the returned data.
    
    Returns:
    
    A List of Views that point to the segments of this buffer.
  - split
```
public java.util.List<Buffer.View> split(java.util.List<Buffer.View> views,
                                         int delimiter,
                                         boolean stripDelimiter)
```
    Split this buffer on the given delimiter, save memory by reusing the given List, and optionally leave the delimiter intact rather than stripping it.
    
    Parameters:
    
    views - The list to store Views in.
    
    delimiter - The delimiter on which to split this buffer.
    
    stripDelimiter - true to ignore the delimiter, false to leave it in the returned data.
    
    Returns:
    
    A List of Views that point to the segments of this buffer.
  - split
```
public java.lang.Iterable<Buffer.View> split(Buffer delimiter)
```
    Split this buffer on the given delimiter and leave the delimiter on the end of each segment.
    
    Parameters:
    
    delimiter - the multi-byte delimiter
    
    Returns:
    
    An Iterable of Views that point to the segments of this buffer.
  - split
```
public java.lang.Iterable<Buffer.View> split(Buffer delimiter,
                                             boolean stripDelimiter)
```
    Split this buffer on the given delimiter. The delimiter is stripped from the end of the segment if stripDelimiter is true.
    
    Parameters:
    
    delimiter - The multi-byte delimiter.
    
    stripDelimiter - true to ignore the delimiter, false to leave it in the returned data.
    
    Returns:
    
    An Iterable of Views that point to the segments of this buffer.
  - split
```
public java.lang.Iterable<Buffer.View> split(java.util.List<Buffer.View> views,
                                             Buffer delimiter,
                                             boolean stripDelimiter)
```
    Split this buffer on the given delimiter. Save memory by reusing the provided List. The delimiter is stripped from the end of the segment if stripDelimiter is true.
    
    Parameters:
    
    views - The already-allocated List to reuse.
    
    delimiter - The multi-byte delimiter.
    
    stripDelimiter - true to ignore the delimiter, false to leave it in the returned data.
    
    Returns:
    
    An Iterable of Views that point to the segments of this buffer.
  - indexOf
```
public int indexOf(byte b)
```
    Search the buffer and find the position of the first occurrence of the given byte.
    
    Parameters:
    
    b - the byte to search for
    
    Returns:
    
    the position of the char in the buffer or -1 if not found
  - indexOf
```
public int indexOf(byte b,
                   int start,
                   int end)
```
    Search the buffer and find the position of the first occurrence of the given byte staring at the start position and searching until (and including) the end position.
    
    Parameters:
    
    b - the byte to search for
    
    start - the position to start searching
    
    end - the position at which to stop searching
    
    Returns:
    
    the position of the char in the buffer or -1 if not found
  - createView
```
public Buffer.View createView()
```
    Create a Buffer.View of the current range of this Buffer.
    
    Returns:
    
    The view of the buffer
    
    See Also:
    
    position(), limit()
  - createView
```
public Buffer.View createView(int start,
                              int end)
```
    Create a Buffer.View of the given range of this Buffer.
    
    Parameters:
    
    start - start of the range.
    
    end - end of the range.
    
    Returns:
    
    A new Buffer.View object that represents the given range.
  - slice
```
public java.util.List<Buffer.View> slice(int... positions)
```
    Slice this buffer at the given positions. Useful for extracting multiple segments of data from a buffer when the exact indices of that data is already known.
    
    Parameters:
    
    positions - The start and end positions of the slices.
    
    Returns:
    
    A list of Views pointing to the slices.
  - byteBuffer
```
public java.nio.ByteBuffer byteBuffer()
```
    Return the underlying ByteBuffer.
    
    Returns:
    
    The ByteBuffer in use.
  - isDelimitingBuffer
```
public boolean isDelimitingBuffer()
```
    Is this instance a delimiting Buffer
    
    Returns:
    
    true if delimiter
    
    Since:
    
    2.0.4
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(Buffer buffer)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Buffer>

Class Buffer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

SMALL_BUFFER_SIZE

MAX_BUFFER_SIZE

DELIMITING_BUFFER

Constructor Detail

Buffer

Buffer

Buffer

Buffer

Method Detail

wrap

wrap

wrap

parseInt

parseInt

parseLong

parseLong

recycle

isDynamic

position

position

limit

skip

limit

capacity

remaining

clear

compact

flip

rewind

rewind

duplicate

copy

prepend

prepend

prepend

prepend

prepend

prepend

prepend

prepend

prepend

append

append

append

append

append

append

append

append

append

append

first

last

read

read

readShort

readInt

readFloat

readDouble

readLong

readChar

snapshot

reset

iterator

read

write

isOpen

close

asString

substring

asBytes

inputStream