SlicedByteBuf (Netty API Reference (5.0.0.Alpha2))

java.lang.Object
- io.netty.buffer.ByteBuf
- - io.netty.buffer.AbstractByteBuf
  - - io.netty.buffer.AbstractDerivedByteBuf
    - - io.netty.buffer.SlicedByteBuf

All Implemented Interfaces:

ReferenceCounted, Comparable<ByteBuf>
```
public class SlicedByteBuf
extends AbstractDerivedByteBuf
```
A derived buffer which exposes its parent's sub-region only. It is recommended to use ByteBuf.slice() and ByteBuf.slice(int, int) instead of calling the constructor explicitly.

Constructor Summary

Constructors
Constructor and Description

SlicedByteBuf(ByteBuf buffer, int index, int length)

Constructors
Constructor and Description
`SlicedByteBuf(ByteBuf buffer, int index, int length)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected byte`	`_getByte(int index)`
`protected int`	`_getInt(int index)`
`protected long`	`_getLong(int index)`
`protected short`	`_getShort(int index)`
`protected int`	`_getUnsignedMedium(int index)`
`protected void`	`_setByte(int index, int value)`
`protected void`	`_setInt(int index, int value)`
`protected void`	`_setLong(int index, long value)`
`protected void`	`_setMedium(int index, int value)`
`protected void`	`_setShort(int index, int value)`
`ByteBufAllocator`	`alloc()` Returns the `ByteBufAllocator` which created this buffer.
`byte[]`	`array()` Returns the backing byte array of this buffer.
`int`	`arrayOffset()` Returns the offset of the first byte within the backing byte array of this buffer.
`int`	`capacity()` Returns the number of bytes (octets) this buffer can contain.
`ByteBuf`	`capacity(int newCapacity)` Adjusts the capacity of this buffer.
`ByteBuf`	`copy(int index, int length)` Returns a copy of this buffer's sub-region.
`ByteBuf`	`duplicate()` Returns a buffer which shares the whole region of this buffer.
`int`	`forEachByte(int index, int length, ByteBufProcessor processor)` Iterates over the specified area of this buffer with the specified `processor` in ascending order.
`int`	`forEachByteDesc(int index, int length, ByteBufProcessor processor)` Iterates over the specified area of this buffer with the specified `processor` in descending order.
`ByteBuf`	`getBytes(int index, byte[] dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the specified absolute `index`.
`ByteBuf`	`getBytes(int index, ByteBuffer dst)` Transfers this buffer's data to the specified destination starting at the specified absolute `index` until the destination's position reaches its limit.
`ByteBuf`	`getBytes(int index, ByteBuf dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the specified absolute `index`.
`int`	`getBytes(int index, GatheringByteChannel out, int length)` Transfers this buffer's data to the specified channel starting at the specified absolute `index`.
`ByteBuf`	`getBytes(int index, OutputStream out, int length)` Transfers this buffer's data to the specified stream starting at the specified absolute `index`.
`boolean`	`hasArray()` Returns `true` if and only if this buffer has a backing byte array.
`boolean`	`hasMemoryAddress()` Returns `true` if and only if this buffer has a reference to the low-level memory address that points to the backing data.
`ByteBuffer`	`internalNioBuffer(int index, int length)` Internal use only: Exposes the internal NIO buffer.
`boolean`	`isDirect()` Returns `true` if and only if this buffer is backed by an NIO direct buffer.
`long`	`memoryAddress()` Returns the low-level memory address that point to the first byte of ths backing data.
`ByteBuffer`	`nioBuffer(int index, int length)` Exposes this buffer's sub-region as an NIO `ByteBuffer`.
`int`	`nioBufferCount()` Returns the maximum number of NIO `ByteBuffer`s that consist this buffer.
`ByteBuffer[]`	`nioBuffers(int index, int length)` Exposes this buffer's bytes as an NIO `ByteBuffer`'s for the specified index and length The returned buffer shares the content with this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer.
`ByteOrder`	`order()` Returns the endianness of this buffer.
`ByteBuf`	`setBytes(int index, byte[] src, int srcIndex, int length)` Transfers the specified source array's data to this buffer starting at the specified absolute `index`.
`ByteBuf`	`setBytes(int index, ByteBuffer src)` Transfers the specified source buffer's data to this buffer starting at the specified absolute `index` until the source buffer's position reaches its limit.
`ByteBuf`	`setBytes(int index, ByteBuf src, int srcIndex, int length)` Transfers the specified source buffer's data to this buffer starting at the specified absolute `index`.
`int`	`setBytes(int index, InputStream in, int length)` Transfers the content of the specified source stream to this buffer starting at the specified absolute `index`.
`int`	`setBytes(int index, ScatteringByteChannel in, int length)` Transfers the content of the specified source channel to this buffer starting at the specified absolute `index`.
`ByteBuf`	`slice(int index, int length)` Returns a slice of this buffer's sub-region.
`ByteBuf`	`unwrap()` Return the underlying buffer instance if this buffer is a wrapper of another buffer.

Methods inherited from class io.netty.buffer.AbstractDerivedByteBuf
refCnt, release, release, retain, retain, touch, touch

Methods inherited from class io.netty.buffer.AbstractByteBuf
adjustMarkers, bytesBefore, bytesBefore, bytesBefore, checkDstIndex, checkIndex, checkIndex, checkReadableBytes, checkSrcIndex, clear, compareTo, copy, discardReadBytes, discardSomeReadBytes, ensureAccessible, ensureWritable, ensureWritable, equals, forEachByte, forEachByteDesc, getBoolean, getByte, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getInt, getLong, getMedium, getShort, getUnsignedByte, getUnsignedInt, getUnsignedMedium, getUnsignedShort, hashCode, indexOf, isReadable, isReadable, isWritable, isWritable, markReaderIndex, markWriterIndex, maxCapacity, maxCapacity, maxWritableBytes, newSwappedByteBuf, nioBuffer, nioBuffers, order, readableBytes, readBoolean, readByte, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readChar, readDouble, readerIndex, readerIndex, readFloat, readInt, readLong, readMedium, readShort, readSlice, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, resetReaderIndex, resetWriterIndex, setBoolean, setByte, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setIndex, setInt, setLong, setMedium, setShort, setZero, skipBytes, slice, toString, toString, toString, writableBytes, writeBoolean, writeByte, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writerIndex, writerIndex, writeShort, writeZero

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

- Constructor Detail
  - SlicedByteBuf
```
public SlicedByteBuf(ByteBuf buffer,
             int index,
             int length)
```
- Method Detail
  - unwrap
```
public ByteBuf unwrap()
```
    Description copied from class: ByteBuf
    
    Return the underlying buffer instance if this buffer is a wrapper of another buffer.
    
    Specified by:
    
    unwrap in class ByteBuf
    
    Returns:
    null if this buffer is not a wrapper
  - alloc
```
public ByteBufAllocator alloc()
```
    Description copied from class: ByteBuf
    
    Returns the ByteBufAllocator which created this buffer.
    
    Specified by:
    
    alloc in class ByteBuf
  - order
```
public ByteOrder order()
```
    Description copied from class: ByteBuf
    
    Returns the endianness of this buffer.
    
    Specified by:
    
    order in class ByteBuf
  - isDirect
```
public boolean isDirect()
```
    Description copied from class: ByteBuf
    
    Returns true if and only if this buffer is backed by an NIO direct buffer.
    
    Specified by:
    
    isDirect in class ByteBuf
  - capacity
```
public int capacity()
```
    Description copied from class: ByteBuf
    
    Returns the number of bytes (octets) this buffer can contain.
    
    Specified by:
    
    capacity in class ByteBuf
  - capacity
```
public ByteBuf capacity(int newCapacity)
```
    Description copied from class: ByteBuf
    
    Adjusts the capacity of this buffer. If the newCapacity is less than the current capacity, the content of this buffer is truncated. If the newCapacity is greater than the current capacity, the buffer is appended with unspecified data whose length is (newCapacity - currentCapacity).
    
    Specified by:
    
    capacity in class ByteBuf
  - hasArray
```
public boolean hasArray()
```
    Description copied from class: ByteBuf
    
    Returns true if and only if this buffer has a backing byte array. If this method returns true, you can safely call ByteBuf.array() and ByteBuf.arrayOffset().
    
    Specified by:
    
    hasArray in class ByteBuf
  - array
```
public byte[] array()
```
    Description copied from class: ByteBuf
    
    Returns the backing byte array of this buffer.
    
    Specified by:
    
    array in class ByteBuf
  - arrayOffset
```
public int arrayOffset()
```
    Description copied from class: ByteBuf
    
    Returns the offset of the first byte within the backing byte array of this buffer.
    
    Specified by:
    
    arrayOffset in class ByteBuf
  - hasMemoryAddress
```
public boolean hasMemoryAddress()
```
    Description copied from class: ByteBuf
    
    Returns true if and only if this buffer has a reference to the low-level memory address that points to the backing data.
    
    Specified by:
    
    hasMemoryAddress in class ByteBuf
  - memoryAddress
```
public long memoryAddress()
```
    Description copied from class: ByteBuf
    
    Returns the low-level memory address that point to the first byte of ths backing data.
    
    Specified by:
    
    memoryAddress in class ByteBuf
  - _getByte
```
protected byte _getByte(int index)
```
    Specified by:
    
    _getByte in class AbstractByteBuf
  - _getShort
```
protected short _getShort(int index)
```
    Specified by:
    
    _getShort in class AbstractByteBuf
  - _getUnsignedMedium
```
protected int _getUnsignedMedium(int index)
```
    Specified by:
    
    _getUnsignedMedium in class AbstractByteBuf
  - _getInt
```
protected int _getInt(int index)
```
    Specified by:
    
    _getInt in class AbstractByteBuf
  - _getLong
```
protected long _getLong(int index)
```
    Specified by:
    
    _getLong in class AbstractByteBuf
  - duplicate
```
public ByteBuf duplicate()
```
    Description copied from class: ByteBuf
    
    Returns a buffer which shares the whole region of this buffer. Modifying the content of the returned buffer or this buffer affects each other's content while they maintain separate indexes and marks. This method is identical to buf.slice(0, buf.capacity()). This method does not modify readerIndex or writerIndex of this buffer.
    
    Overrides:
    
    duplicate in class AbstractByteBuf
  - copy
```
public ByteBuf copy(int index,
           int length)
```
    Description copied from class: ByteBuf
    
    Returns a copy of this buffer's sub-region. Modifying the content of the returned buffer or this buffer does not affect each other at all. This method does not modify readerIndex or writerIndex of this buffer.
    
    Specified by:
    
    copy in class ByteBuf
  - slice
```
public ByteBuf slice(int index,
            int length)
```
    Description copied from class: ByteBuf
    
    Returns a slice of this buffer's sub-region. Modifying the content of the returned buffer or this buffer affects each other's content while they maintain separate indexes and marks. This method does not modify readerIndex or writerIndex of this buffer.
    
    Overrides:
    
    slice in class AbstractByteBuf
  - getBytes
```
public ByteBuf getBytes(int index,
               ByteBuf dst,
               int dstIndex,
               int length)
```
    Description copied from class: ByteBuf
    
    Transfers this buffer's data to the specified destination starting at the specified absolute index. This method does not modify readerIndex or writerIndex of both the source (i.e. this) and the destination.
    
    Specified by:
    
    getBytes in class ByteBuf
    
    dstIndex - the first index of the destination
    length - the number of bytes to transfer
  - getBytes
```
public ByteBuf getBytes(int index,
               byte[] dst,
               int dstIndex,
               int length)
```
    Description copied from class: ByteBuf
    
    Transfers this buffer's data to the specified destination starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
    
    Specified by:
    
    getBytes in class ByteBuf
    
    dstIndex - the first index of the destination
    length - the number of bytes to transfer
  - getBytes
```
public ByteBuf getBytes(int index,
               ByteBuffer dst)
```
    Description copied from class: ByteBuf
    
    Transfers this buffer's data to the specified destination starting at the specified absolute index until the destination's position reaches its limit. This method does not modify readerIndex or writerIndex of this buffer while the destination's position will be increased.
    
    Specified by:
    
    getBytes in class ByteBuf
  - _setByte
```
protected void _setByte(int index,
            int value)
```
    Specified by:
    
    _setByte in class AbstractByteBuf
  - _setShort
```
protected void _setShort(int index,
             int value)
```
    Specified by:
    
    _setShort in class AbstractByteBuf
  - _setMedium
```
protected void _setMedium(int index,
              int value)
```
    Specified by:
    
    _setMedium in class AbstractByteBuf
  - _setInt
```
protected void _setInt(int index,
           int value)
```
    Specified by:
    
    _setInt in class AbstractByteBuf
  - _setLong
```
protected void _setLong(int index,
            long value)
```
    Specified by:
    
    _setLong in class AbstractByteBuf
  - setBytes
```
public ByteBuf setBytes(int index,
               byte[] src,
               int srcIndex,
               int length)
```
    Description copied from class: ByteBuf
    
    Transfers the specified source array's data to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
    
    Specified by:
    
    setBytes in class ByteBuf
  - setBytes
```
public ByteBuf setBytes(int index,
               ByteBuf src,
               int srcIndex,
               int length)
```
    Description copied from class: ByteBuf
    
    Transfers the specified source buffer's data to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of both the source (i.e. this) and the destination.
    
    Specified by:
    
    setBytes in class ByteBuf
    
    srcIndex - the first index of the source
    length - the number of bytes to transfer
  - setBytes
```
public ByteBuf setBytes(int index,
               ByteBuffer src)
```
    Description copied from class: ByteBuf
    
    Transfers the specified source buffer's data to this buffer starting at the specified absolute index until the source buffer's position reaches its limit. This method does not modify readerIndex or writerIndex of this buffer.
    
    Specified by:
    
    setBytes in class ByteBuf
  - getBytes
```
public ByteBuf getBytes(int index,
               OutputStream out,
               int length)
                 throws IOException
```
    Description copied from class: ByteBuf
    
    Transfers this buffer's data to the specified stream starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
    
    Specified by:
    
    getBytes in class ByteBuf
    
    length - the number of bytes to transfer
    
    Throws:
    
    IOException - if the specified stream threw an exception during I/O
  - getBytes
```
public int getBytes(int index,
           GatheringByteChannel out,
           int length)
             throws IOException
```
    Description copied from class: ByteBuf
    
    Transfers this buffer's data to the specified channel starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
    
    Specified by:
    
    getBytes in class ByteBuf
    
    length - the maximum number of bytes to transfer
    
    Returns:
    the actual number of bytes written out to the specified channel
    
    Throws:
    
    IOException - if the specified channel threw an exception during I/O
  - setBytes
```
public int setBytes(int index,
           InputStream in,
           int length)
             throws IOException
```
    Description copied from class: ByteBuf
    
    Transfers the content of the specified source stream to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
    
    Specified by:
    
    setBytes in class ByteBuf
    
    length - the number of bytes to transfer
    
    Returns:
    the actual number of bytes read in from the specified channel. -1 if the specified channel is closed.
    
    Throws:
    
    IOException - if the specified stream threw an exception during I/O
  - setBytes
```
public int setBytes(int index,
           ScatteringByteChannel in,
           int length)
             throws IOException
```
    Description copied from class: ByteBuf
    
    Transfers the content of the specified source channel to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.
    
    Specified by:
    
    setBytes in class ByteBuf
    
    length - the maximum number of bytes to transfer
    
    Returns:
    the actual number of bytes read in from the specified channel. -1 if the specified channel is closed.
    
    Throws:
    
    IOException - if the specified channel threw an exception during I/O
  - nioBufferCount
```
public int nioBufferCount()
```
    Description copied from class: ByteBuf
    
    Returns the maximum number of NIO ByteBuffers that consist this buffer. Note that ByteBuf.nioBuffers() or ByteBuf.nioBuffers(int, int) might return a less number of ByteBuffers.
    
    Specified by:
    
    nioBufferCount in class ByteBuf
    
    Returns:
    -1 if this buffer has no underlying ByteBuffer. the number of the underlying ByteBuffers if this buffer has at least one underlying ByteBuffer. Note that this method does not return 0 to avoid confusion.
    See Also:
    ByteBuf.nioBuffer(), ByteBuf.nioBuffer(int, int), ByteBuf.nioBuffers(), ByteBuf.nioBuffers(int, int)
  - nioBuffer
```
public ByteBuffer nioBuffer(int index,
                   int length)
```
    Description copied from class: ByteBuf
    
    Exposes this buffer's sub-region as an NIO ByteBuffer. The returned buffer shares the content with this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does not modify readerIndex or writerIndex of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity.
    
    Overrides:
    
    nioBuffer in class AbstractDerivedByteBuf
    
    See Also:
    ByteBuf.nioBufferCount(), ByteBuf.nioBuffers(), ByteBuf.nioBuffers(int, int)
  - nioBuffers
```
public ByteBuffer[] nioBuffers(int index,
                      int length)
```
    Description copied from class: ByteBuf
    
    Exposes this buffer's bytes as an NIO ByteBuffer's for the specified index and length The returned buffer shares the content with this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does not modify readerIndex or writerIndex of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity.
    
    Specified by:
    
    nioBuffers in class ByteBuf
    
    See Also:
    ByteBuf.nioBufferCount(), ByteBuf.nioBuffer(), ByteBuf.nioBuffer(int, int)
  - internalNioBuffer
```
public ByteBuffer internalNioBuffer(int index,
                           int length)
```
    Description copied from class: ByteBuf
    
    Internal use only: Exposes the internal NIO buffer.
    
    Overrides:
    
    internalNioBuffer in class AbstractDerivedByteBuf
  - forEachByte
```
public int forEachByte(int index,
              int length,
              ByteBufProcessor processor)
```
    Description copied from class: ByteBuf
    
    Iterates over the specified area of this buffer with the specified processor in ascending order. (i.e. index, (index + 1), .. (index + length - 1))
    
    Overrides:
    
    forEachByte in class AbstractByteBuf
    
    Returns:
    -1 if the processor iterated to or beyond the end of the specified area. The last-visited index If the ByteBufProcessor.process(byte) returned false.
  - forEachByteDesc
```
public int forEachByteDesc(int index,
                  int length,
                  ByteBufProcessor processor)
```
    Description copied from class: ByteBuf
    
    Iterates over the specified area of this buffer with the specified processor in descending order. (i.e. (index + length - 1), (index + length - 2), ... index)
    
    Overrides:
    
    forEachByteDesc in class AbstractByteBuf
    
    Returns:
    -1 if the processor iterated to or beyond the beginning of the specified area. The last-visited index If the ByteBufProcessor.process(byte) returned false.

Class SlicedByteBuf

Constructor Summary

Method Summary

Methods inherited from class io.netty.buffer.AbstractDerivedByteBuf

Methods inherited from class io.netty.buffer.AbstractByteBuf

Methods inherited from class java.lang.Object

Constructor Detail

SlicedByteBuf

Method Detail

unwrap

alloc

order

isDirect

capacity

capacity

hasArray

array

arrayOffset

hasMemoryAddress

memoryAddress

_getByte

_getShort

_getUnsignedMedium

_getInt

_getLong

duplicate

copy

slice

getBytes

getBytes

getBytes

_setByte

_setShort

_setMedium

_setInt

_setLong

setBytes

setBytes

setBytes

getBytes

getBytes

setBytes

setBytes

nioBufferCount

nioBuffer

nioBuffers

internalNioBuffer

forEachByte

forEachByteDesc