DirectByteBuf (Netty/Buffer 4.0.0.Alpha3 API)

java.lang.Object
- io.netty.buffer.AbstractByteBuf
- - io.netty.buffer.DirectByteBuf

All Implemented Interfaces:

ByteBuf, ChannelBuf, Comparable<ByteBuf>
```
public class DirectByteBuf
extends AbstractByteBuf
```
A NIO ByteBuffer based buffer. It is recommended to use Unpooled.directBuffer(int) and Unpooled.wrappedBuffer(ByteBuffer) instead of calling the constructor explicitly.

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.buffer.ByteBuf
  ByteBuf.Unsafe

Constructor Summary

Constructors
Constructor and Description
`DirectByteBuf(ByteBuffer initialBuffer, int maxCapacity)` Creates a new direct buffer by wrapping the specified initial buffer.
`DirectByteBuf(int initialCapacity, int maxCapacity)` Creates a new direct buffer.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`void`	`capacity(int newCapacity)` Adjusts the capacity of this buffer.
`ByteBuf`	`copy(int index, int length)` Returns a copy of this buffer's sub-region.
`byte`	`getByte(int index)` Gets a byte at the specified absolute `index` in this buffer.
`void`	`getBytes(int index, byte[] dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the specified absolute `index`.
`void`	`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.
`void`	`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`.
`void`	`getBytes(int index, OutputStream out, int length)` Transfers this buffer's data to the specified stream starting at the specified absolute `index`.
`int`	`getInt(int index)` Gets a 32-bit integer at the specified absolute `index` in this buffer.
`long`	`getLong(int index)` Gets a 64-bit long integer at the specified absolute `index` in this buffer.
`short`	`getShort(int index)` Gets a 16-bit short integer at the specified absolute `index` in this buffer.
`int`	`getUnsignedMedium(int index)` Gets an unsigned 24-bit medium integer at the specified absolute `index` in this buffer.
`boolean`	`hasArray()` Returns `true` if and only if this buffer has a backing byte array.
`boolean`	`hasNioBuffer()` Returns `true` if and only if `ByteBuf.nioBuffer()` method will not fail.
`boolean`	`hasNioBuffers()` Returns `true` if and only if `ByteBuf.nioBuffers()` method will not fail.
`boolean`	`isDirect()` Returns `true` if and only if this buffer is backed by an NIO direct buffer.
`ByteBuffer`	`nioBuffer(int index, int length)` Exposes this buffer's sub-region as an NIO `ByteBuffer`.
`ByteBuffer[]`	`nioBuffers(int offset, int length)` Exposes this buffer's bytes as an NIO `ByteBuffer`'s for the specified offset 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.
`void`	`setByte(int index, int value)` Sets the specified byte at the specified absolute `index` in this buffer.
`void`	`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`.
`void`	`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.
`void`	`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`.
`void`	`setInt(int index, int value)` Sets the specified 32-bit integer at the specified absolute `index` in this buffer.
`void`	`setLong(int index, long value)` Sets the specified 64-bit long integer at the specified absolute `index` in this buffer.
`void`	`setMedium(int index, int value)` Sets the specified 24-bit medium integer at the specified absolute `index` in this buffer.
`void`	`setShort(int index, int value)` Sets the specified 16-bit short integer at the specified absolute `index` in this buffer.
`ByteBuf.Unsafe`	`unsafe()` Returns an object that exposes unsafe expert-only operations which can lead to unspecified behavior.

Methods inherited from class io.netty.buffer.AbstractByteBuf
adjustMarkers, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, checkReadableBytes, clear, compareTo, copy, discardReadBytes, duplicate, ensureWritableBytes, ensureWritableBytes, equals, getBoolean, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getMedium, getUnsignedByte, getUnsignedInt, getUnsignedShort, hashCode, indexOf, indexOf, isPooled, markReaderIndex, markWriterIndex, maxCapacity, nioBuffer, nioBuffers, order, order, readable, 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, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setIndex, setZero, skipBytes, slice, slice, toString, toString, toString, type, writable, 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
  - DirectByteBuf
```
public DirectByteBuf(int initialCapacity,
             int maxCapacity)
```
    Creates a new direct buffer.
    
    Parameters:
    initialCapacity - the initial capacity of the underlying direct buffer
    maxCapacity - the maximum capacity of the underlying direct buffer
  - DirectByteBuf
```
public DirectByteBuf(ByteBuffer initialBuffer,
             int maxCapacity)
```
    Creates a new direct buffer by wrapping the specified initial buffer.
    
    Parameters:
    maxCapacity - the maximum capacity of the underlying direct buffer
- Method Detail
  - isDirect
```
public boolean isDirect()
```
    Description copied from interface: ByteBuf
    
    Returns true if and only if this buffer is backed by an NIO direct buffer.
  - capacity
```
public int capacity()
```
    Description copied from interface: ByteBuf
    
    Returns the number of bytes (octets) this buffer can contain.
  - capacity
```
public void capacity(int newCapacity)
```
    Description copied from interface: 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).
  - hasArray
```
public boolean hasArray()
```
    Description copied from interface: 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().
  - array
```
public byte[] array()
```
    Description copied from interface: ByteBuf
    
    Returns the backing byte array of this buffer.
  - arrayOffset
```
public int arrayOffset()
```
    Description copied from interface: ByteBuf
    
    Returns the offset of the first byte within the backing byte array of this buffer.
  - getByte
```
public byte getByte(int index)
```
    Description copied from interface: ByteBuf
    
    Gets a byte at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
  - getShort
```
public short getShort(int index)
```
    Description copied from interface: ByteBuf
    
    Gets a 16-bit short integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
  - getUnsignedMedium
```
public int getUnsignedMedium(int index)
```
    Description copied from interface: ByteBuf
    
    Gets an unsigned 24-bit medium integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
  - getInt
```
public int getInt(int index)
```
    Description copied from interface: ByteBuf
    
    Gets a 32-bit integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
  - getLong
```
public long getLong(int index)
```
    Description copied from interface: ByteBuf
    
    Gets a 64-bit long integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
  - getBytes
```
public void getBytes(int index,
            ByteBuf dst,
            int dstIndex,
            int length)
```
    Description copied from interface: 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.
    
    dstIndex - the first index of the destination
    length - the number of bytes to transfer
  - getBytes
```
public void getBytes(int index,
            byte[] dst,
            int dstIndex,
            int length)
```
    Description copied from interface: 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.
    
    dstIndex - the first index of the destination
    length - the number of bytes to transfer
  - getBytes
```
public void getBytes(int index,
            ByteBuffer dst)
```
    Description copied from interface: 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.
  - setByte
```
public void setByte(int index,
           int value)
```
    Description copied from interface: ByteBuf
    
    Sets the specified byte at the specified absolute index in this buffer. The 24 high-order bits of the specified value are ignored. This method does not modify readerIndex or writerIndex of this buffer.
  - setShort
```
public void setShort(int index,
            int value)
```
    Description copied from interface: ByteBuf
    
    Sets the specified 16-bit short integer at the specified absolute index in this buffer. The 16 high-order bits of the specified value are ignored. This method does not modify readerIndex or writerIndex of this buffer.
  - setMedium
```
public void setMedium(int index,
             int value)
```
    Description copied from interface: ByteBuf
    
    Sets the specified 24-bit medium integer at the specified absolute index in this buffer. Please note that the most significant byte is ignored in the specified value. This method does not modify readerIndex or writerIndex of this buffer.
  - setInt
```
public void setInt(int index,
          int value)
```
    Description copied from interface: ByteBuf
    
    Sets the specified 32-bit integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
  - setLong
```
public void setLong(int index,
           long value)
```
    Description copied from interface: ByteBuf
    
    Sets the specified 64-bit long integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.
  - setBytes
```
public void setBytes(int index,
            ByteBuf src,
            int srcIndex,
            int length)
```
    Description copied from interface: 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.
    
    srcIndex - the first index of the source
    length - the number of bytes to transfer
  - setBytes
```
public void setBytes(int index,
            byte[] src,
            int srcIndex,
            int length)
```
    Description copied from interface: 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.
  - setBytes
```
public void setBytes(int index,
            ByteBuffer src)
```
    Description copied from interface: 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.
  - getBytes
```
public void getBytes(int index,
            OutputStream out,
            int length)
              throws IOException
```
    Description copied from interface: 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.
    
    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 interface: 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.
    
    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 interface: 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.
    
    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 interface: 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.
    
    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
  - hasNioBuffer
```
public boolean hasNioBuffer()
```
    Description copied from interface: ByteBuf
    
    Returns true if and only if ByteBuf.nioBuffer() method will not fail.
  - nioBuffer
```
public ByteBuffer nioBuffer(int index,
                   int length)
```
    Description copied from interface: 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.
  - hasNioBuffers
```
public boolean hasNioBuffers()
```
    Description copied from interface: ByteBuf
    
    Returns true if and only if ByteBuf.nioBuffers() method will not fail.
  - nioBuffers
```
public ByteBuffer[] nioBuffers(int offset,
                      int length)
```
    Description copied from interface: ByteBuf
    
    Exposes this buffer's bytes as an NIO ByteBuffer's for the specified offset 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.
  - copy
```
public ByteBuf copy(int index,
           int length)
```
    Description copied from interface: 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.
  - unsafe
```
public ByteBuf.Unsafe unsafe()
```
    Description copied from interface: ByteBuf
    
    Returns an object that exposes unsafe expert-only operations which can lead to unspecified behavior.

Class DirectByteBuf

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.buffer.ByteBuf

Constructor Summary

Method Summary

Methods inherited from class io.netty.buffer.AbstractByteBuf

Methods inherited from class java.lang.Object

Constructor Detail

DirectByteBuf

DirectByteBuf

Method Detail

isDirect

capacity

capacity

hasArray

array

arrayOffset

getByte

getShort

getUnsignedMedium

getInt

getLong

getBytes

getBytes

getBytes

setByte

setShort

setMedium

setInt

setLong

setBytes

setBytes

setBytes

getBytes

getBytes

setBytes

setBytes

hasNioBuffer

nioBuffer

hasNioBuffers

nioBuffers

copy

unsafe