SingleByteBuff (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.nio.ByteBuff
- - org.apache.hadoop.hbase.nio.SingleByteBuff

All Implemented Interfaces:

HBaseReferenceCounted, org.apache.hbase.thirdparty.io.netty.util.ReferenceCounted
```
@InterfaceAudience.Private
public class SingleByteBuff
extends ByteBuff
```
An implementation of ByteBuff where a single BB backs the BBI. This just acts as a wrapper over a normal BB - offheap or onheap

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.hadoop.hbase.nio.ByteBuff
  ByteBuff.ChannelReader

Field Summary

Fields
Modifier and Type	Field and Description
`private ByteBuffer`	`buf`
`private static boolean`	`UNSAFE_AVAIL`
`private static boolean`	`UNSAFE_UNALIGNED`
`private long`	`unsafeOffset`
`private Object`	`unsafeRef`

Fields inherited from class org.apache.hadoop.hbase.nio.ByteBuff
CHANNEL_READER, FILE_READER, refCnt

Constructor Summary

Constructors
Constructor and Description
`SingleByteBuff(ByteBuffAllocator.Recycler recycler, ByteBuffer buf)`
`SingleByteBuff(ByteBuffer buf)`
`SingleByteBuff(RefCnt refCnt, ByteBuffer buf)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`array()` Returns the byte[] if the underlying BB has single BB and hasArray true
`int`	`arrayOffset()` Returns the arrayOffset of the byte[] incase of a single BB backed ByteBuff
`ByteBuffer`	`asSubByteBuffer(int length)` Returns bytes from current position till length specified, as a single ByteBuffer.
`void`	`asSubByteBuffer(int offset, int length, ObjectIntPair<ByteBuffer> pair)` Returns bytes from given offset till length specified, as a single ByteBuffer.
`int`	`capacity()` Returns the total capacity of this ByteBuff.
`SingleByteBuff`	`duplicate()` Returns an ByteBuff which is a duplicate version of this ByteBuff.
`boolean`	`equals(Object obj)`
`byte`	`get()` A relative method that returns byte at the current position.
`void`	`get(byte[] dst)` Copies the content from this ByteBuff's current position to the byte array and fills it.
`void`	`get(byte[] dst, int offset, int length)` Copies the specified number of bytes from this ByteBuff's current position to the byte[]'s offset.
`void`	`get(ByteBuffer out, int sourceOffset, int length)` Copies the content from this ByteBuff to a ByteBuffer Note : This will advance the position marker of `out` but not change the position maker for this ByteBuff
`byte`	`get(int index)` Fetches the byte at the given index.
`void`	`get(int sourceOffset, byte[] dst, int offset, int length)` Copies the specified number of bytes from this ByteBuff's given position to the byte[]'s offset.
`byte`	`getByteAfterPosition(int offset)` Fetches the byte at the given offset from current position.
`int`	`getInt()` Returns the int value at the current position.
`int`	`getInt(int index)` Fetches the int at the given index.
`int`	`getIntAfterPosition(int offset)` Fetches the int value at the given offset from current position.
`long`	`getLong()` Returns the long value at the current position.
`long`	`getLong(int index)` Fetches the long at the given index.
`long`	`getLongAfterPosition(int offset)` Fetches the long value at the given offset from current position.
`short`	`getShort()` Returns the short value at the current position.
`short`	`getShort(int index)` Fetches the short value at the given index.
`short`	`getShortAfterPosition(int offset)` Fetches the short value at the given offset from current position.
`boolean`	`hasArray()` Returns true or false if the underlying BB support hasArray
`int`	`hashCode()`
`boolean`	`hasRemaining()` Returns true if there are elements between the current position and the limit.
`int`	`limit()` Returns the limit of this ByteBuff
`SingleByteBuff`	`limit(int limit)` Marks the limit of this ByteBuff
`SingleByteBuff`	`mark()` Marks the current position of the ByteBuff
`SingleByteBuff`	`moveBack(int len)` Jumps back the current position of this ByteBuff by specified length.
`ByteBuffer[]`	`nioByteBuffers()`
`int`	`position()` Returns this ByteBuff's current position
`SingleByteBuff`	`position(int position)` Sets this ByteBuff's position to the given value.
`SingleByteBuff`	`put(byte b)` Writes a byte to this ByteBuff at the current position and increments the position
`SingleByteBuff`	`put(byte[] src)` Copies from the given byte[] to this ByteBuff n * @return this ByteBuff
`SingleByteBuff`	`put(byte[] src, int offset, int length)` Copies from the given byte[] to this ByteBuff
`SingleByteBuff`	`put(int index, byte b)` Writes a byte to this ByteBuff at the given index
`SingleByteBuff`	`put(int offset, ByteBuff src, int srcOffset, int length)` Copies the contents from the src ByteBuff to this ByteBuff.
`SingleByteBuff`	`putInt(int value)` Writes an int to this ByteBuff at its current position.
`SingleByteBuff`	`putLong(long value)` Writes a long to this ByteBuff at its current position.
`int`	`read(FileChannel channel, long offset)` Reads bytes from FileChannel into this ByteBuff
`int`	`read(ReadableByteChannel channel)` Reads bytes from the given channel into this ByteBuf.
`int`	`remaining()` Returns the number of elements between the current position and the limit.
`SingleByteBuff`	`reset()` Similar to `ByteBuffer`.reset(), ensures that this ByteBuff is reset back to last marked position.
`SingleByteBuff`	`retain()`
`SingleByteBuff`	`rewind()` Rewinds this ByteBuff and the position is set to 0
`SingleByteBuff`	`skip(int len)` Jumps the current position of this ByteBuff by specified length.
`SingleByteBuff`	`slice()` Returns an ByteBuff which is a sliced version of this ByteBuff.
`byte[]`	`toBytes(int offset, int length)` Copy the content from this ByteBuff to a byte[] based on the given offset and length.
`int`	`write(FileChannel channel, long offset)` Write this ByteBuff's data into target file

Methods inherited from class org.apache.hadoop.hbase.nio.ByteBuff
checkRefCount, compareTo, getRefCnt, read, readCompressedInt, readLong, refCnt, release, toBytes, toString, touch, touch, wrap, wrap, wrap, wrap, wrap, wrap

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

Methods inherited from interface org.apache.hadoop.hbase.nio.HBaseReferenceCounted
release, retain

- Field Detail
  - UNSAFE_AVAIL
```
private static final boolean UNSAFE_AVAIL
```
  - UNSAFE_UNALIGNED
```
private static final boolean UNSAFE_UNALIGNED
```
  - buf
```
private final ByteBuffer buf
```
  - unsafeOffset
```
private long unsafeOffset
```
  - unsafeRef
```
private Object unsafeRef
```
- Constructor Detail
  - SingleByteBuff
```
public SingleByteBuff(ByteBuffer buf)
```
  - SingleByteBuff
```
public SingleByteBuff(ByteBuffAllocator.Recycler recycler,
                      ByteBuffer buf)
```
  - SingleByteBuff
```
SingleByteBuff(RefCnt refCnt,
               ByteBuffer buf)
```
- Method Detail
  - position
```
public int position()
```
    Description copied from class: ByteBuff
    
    Returns this ByteBuff's current position
    
    Specified by:
    
    position in class ByteBuff
  - position
```
public SingleByteBuff position(int position)
```
    Description copied from class: ByteBuff
    
    Sets this ByteBuff's position to the given value. n * @return this object
    
    Specified by:
    
    position in class ByteBuff
  - skip
```
public SingleByteBuff skip(int len)
```
    Description copied from class: ByteBuff
    
    Jumps the current position of this ByteBuff by specified length.
    
    Specified by:
    
    skip in class ByteBuff
    
    Parameters:
    
    len - the length to be skipped
  - moveBack
```
public SingleByteBuff moveBack(int len)
```
    Description copied from class: ByteBuff
    
    Jumps back the current position of this ByteBuff by specified length.
    
    Specified by:
    
    moveBack in class ByteBuff
    
    Parameters:
    
    len - the length to move back
  - capacity
```
public int capacity()
```
    Description copied from class: ByteBuff
    
    Returns the total capacity of this ByteBuff.
    
    Specified by:
    
    capacity in class ByteBuff
  - limit
```
public int limit()
```
    Description copied from class: ByteBuff
    
    Returns the limit of this ByteBuff
    
    Specified by:
    
    limit in class ByteBuff
  - limit
```
public SingleByteBuff limit(int limit)
```
    Description copied from class: ByteBuff
    
    Marks the limit of this ByteBuff
    
    Specified by:
    
    limit in class ByteBuff
  - rewind
```
public SingleByteBuff rewind()
```
    Description copied from class: ByteBuff
    
    Rewinds this ByteBuff and the position is set to 0
    
    Specified by:
    
    rewind in class ByteBuff
  - mark
```
public SingleByteBuff mark()
```
    Description copied from class: ByteBuff
    
    Marks the current position of the ByteBuff
    
    Specified by:
    
    mark in class ByteBuff
  - asSubByteBuffer
```
public ByteBuffer asSubByteBuffer(int length)
```
    Description copied from class: ByteBuff
    
    Returns bytes from current position till length specified, as a single ByteBuffer. When all these bytes happen to be in a single ByteBuffer, which this object wraps, that ByteBuffer item as such will be returned. So users are warned not to change the position or limit of this returned ByteBuffer. The position of the returned byte buffer is at the begin of the required bytes. When the required bytes happen to span across multiple ByteBuffers, this API will copy the bytes to a newly created ByteBuffer of required size and return that.
    
    Specified by:
    
    asSubByteBuffer in class ByteBuff
    
    Parameters:
    
    length - number of bytes required.
    
    Returns:
    
    bytes from current position till length specified, as a single ByteButter.
  - asSubByteBuffer
```
public void asSubByteBuffer(int offset,
                            int length,
                            ObjectIntPair<ByteBuffer> pair)
```
    Description copied from class: ByteBuff
    
    Returns bytes from given offset till length specified, as a single ByteBuffer. When all these bytes happen to be in a single ByteBuffer, which this object wraps, that ByteBuffer item as such will be returned (with offset in this ByteBuffer where the bytes starts). So users are warned not to change the position or limit of this returned ByteBuffer. When the required bytes happen to span across multiple ByteBuffers, this API will copy the bytes to a newly created ByteBuffer of required size and return that.
    
    Specified by:
    
    asSubByteBuffer in class ByteBuff
    
    Parameters:
    
    offset - the offset in this ByteBuff from where the subBuffer should be created
    
    length - the length of the subBuffer
    
    pair - a pair that will have the bytes from the current position till length specified, as a single ByteBuffer and offset in that Buffer where the bytes starts. Since this API gets called in a loop we are passing a pair to it which could be created outside the loop and the method would set the values on the pair that is passed in by the caller. Thus it avoids more object creations that would happen if the pair that is returned is created by this method every time.
  - remaining
```
public int remaining()
```
    Description copied from class: ByteBuff
    
    Returns the number of elements between the current position and the limit.
    
    Specified by:
    
    remaining in class ByteBuff
  - hasRemaining
```
public boolean hasRemaining()
```
    Description copied from class: ByteBuff
    
    Returns true if there are elements between the current position and the limit.
    
    Specified by:
    
    hasRemaining in class ByteBuff
  - reset
```
public SingleByteBuff reset()
```
    Description copied from class: ByteBuff
    
    Similar to ByteBuffer.reset(), ensures that this ByteBuff is reset back to last marked position.
    
    Specified by:
    
    reset in class ByteBuff
    
    Returns:
    
    This ByteBuff
  - slice
```
public SingleByteBuff slice()
```
    Description copied from class: ByteBuff
    
    Returns an ByteBuff which is a sliced version of this ByteBuff. The position, limit and mark of the new ByteBuff will be independent than that of the original ByteBuff. The content of the new ByteBuff will start at this ByteBuff's current position
    
    Specified by:
    
    slice in class ByteBuff
    
    Returns:
    
    a sliced ByteBuff
  - duplicate
```
public SingleByteBuff duplicate()
```
    Description copied from class: ByteBuff
    
    Returns an ByteBuff which is a duplicate version of this ByteBuff. The position, limit and mark of the new ByteBuff will be independent than that of the original ByteBuff. The content of the new ByteBuff will start at this ByteBuff's current position The position, limit and mark of the new ByteBuff would be identical to this ByteBuff in terms of values.
    
    Specified by:
    
    duplicate in class ByteBuff
    
    Returns:
    
    a sliced ByteBuff
  - get
```
public byte get()
```
    Description copied from class: ByteBuff
    
    A relative method that returns byte at the current position. Increments the current position by the size of a byte.
    
    Specified by:
    
    get in class ByteBuff
    
    Returns:
    
    the byte at the current position
  - get
```
public byte get(int index)
```
    Description copied from class: ByteBuff
    
    Fetches the byte at the given index. Does not change position of the underlying ByteBuffers n
    
    Specified by:
    
    get in class ByteBuff
    
    Returns:
    
    the byte at the given index
  - getByteAfterPosition
```
public byte getByteAfterPosition(int offset)
```
    Description copied from class: ByteBuff
    
    Fetches the byte at the given offset from current position. Does not change position of the underlying ByteBuffers.
    
    Specified by:
    
    getByteAfterPosition in class ByteBuff
    
    Returns:
    
    the byte value at the given index.
  - put
```
public SingleByteBuff put(byte b)
```
    Description copied from class: ByteBuff
    
    Writes a byte to this ByteBuff at the current position and increments the position
    
    Specified by:
    
    put in class ByteBuff
    
    Returns:
    
    this object
  - put
```
public SingleByteBuff put(int index,
                          byte b)
```
    Description copied from class: ByteBuff
    
    Writes a byte to this ByteBuff at the given index
    
    Specified by:
    
    put in class ByteBuff
    
    Returns:
    
    this object
  - get
```
public void get(byte[] dst,
                int offset,
                int length)
```
    Description copied from class: ByteBuff
    
    Copies the specified number of bytes from this ByteBuff's current position to the byte[]'s offset. Also advances the position of the ByteBuff by the given length.
    
    Specified by:
    
    get in class ByteBuff
    
    Parameters:
    
    dst - the byte[] to which the ByteBuff's content is to be copied
    
    offset - within the current array
    
    length - upto which the bytes to be copied
  - get
```
public void get(int sourceOffset,
                byte[] dst,
                int offset,
                int length)
```
    Description copied from class: ByteBuff
    
    Copies the specified number of bytes from this ByteBuff's given position to the byte[]'s offset. The position of the ByteBuff remains in the current position only
    
    Specified by:
    
    get in class ByteBuff
    
    Parameters:
    
    sourceOffset - the offset in this ByteBuff from where the copy should happen
    
    dst - the byte[] to which the ByteBuff's content is to be copied
    
    offset - within the current array
    
    length - upto which the bytes to be copied
  - get
```
public void get(byte[] dst)
```
    Description copied from class: ByteBuff
    
    Copies the content from this ByteBuff's current position to the byte array and fills it. Also advances the position of the ByteBuff by the length of the byte[].
    
    Specified by:
    
    get in class ByteBuff
    
    Parameters:
    
    dst - the byte[] to which the ByteBuff's content is to be copied
  - put
```
public SingleByteBuff put(int offset,
                          ByteBuff src,
                          int srcOffset,
                          int length)
```
    Description copied from class: ByteBuff
    
    Copies the contents from the src ByteBuff to this ByteBuff. This will be absolute positional copying and won't affect the position of any of the buffers.
    
    Specified by:
    
    put in class ByteBuff
    
    Parameters:
    
    offset - the position in this ByteBuff to which the copy should happen
    
    src - the src ByteBuff
    
    srcOffset - the offset in the src ByteBuff from where the elements should be read
    
    length - the length up to which the copy should happen
  - put
```
public SingleByteBuff put(byte[] src,
                          int offset,
                          int length)
```
    Description copied from class: ByteBuff
    
    Copies from the given byte[] to this ByteBuff
    
    Specified by:
    
    put in class ByteBuff
    
    Parameters:
    
    src - source byte array
    
    offset - the position in the byte array from which the copy should be done
    
    length - the length upto which the copy should happen
    
    Returns:
    
    this ByteBuff
  - put
```
public SingleByteBuff put(byte[] src)
```
    Description copied from class: ByteBuff
    
    Copies from the given byte[] to this ByteBuff n * @return this ByteBuff
    
    Specified by:
    
    put in class ByteBuff
    
    Parameters:
    
    src - source byte array
    
    Returns:
    
    this ByteBuff
  - hasArray
```
public boolean hasArray()
```
    Description copied from class: ByteBuff
    
    Returns true or false if the underlying BB support hasArray
    
    Specified by:
    
    hasArray in class ByteBuff
  - array
```
public byte[] array()
```
    Description copied from class: ByteBuff
    
    Returns the byte[] if the underlying BB has single BB and hasArray true
    
    Specified by:
    
    array in class ByteBuff
  - arrayOffset
```
public int arrayOffset()
```
    Description copied from class: ByteBuff
    
    Returns the arrayOffset of the byte[] incase of a single BB backed ByteBuff
    
    Specified by:
    
    arrayOffset in class ByteBuff
  - getShort
```
public short getShort()
```
    Description copied from class: ByteBuff
    
    Returns the short value at the current position. Also advances the position by the size of short.
    
    Specified by:
    
    getShort in class ByteBuff
  - getShort
```
public short getShort(int index)
```
    Description copied from class: ByteBuff
    
    Fetches the short value at the given index. Does not change position of the underlying ByteBuffers. The caller is sure that the index will be after the current position of this ByteBuff. So even if the current short does not fit in the current item we can safely move to the next item and fetch the remaining bytes forming the short n * @return the short value at the given index
    
    Specified by:
    
    getShort in class ByteBuff
  - getShortAfterPosition
```
public short getShortAfterPosition(int offset)
```
    Description copied from class: ByteBuff
    
    Fetches the short value at the given offset from current position. Does not change position of the underlying ByteBuffers. n * @return the short value at the given index.
    
    Specified by:
    
    getShortAfterPosition in class ByteBuff
  - getInt
```
public int getInt()
```
    Description copied from class: ByteBuff
    
    Returns the int value at the current position. Also advances the position by the size of int.
    
    Specified by:
    
    getInt in class ByteBuff
  - putInt
```
public SingleByteBuff putInt(int value)
```
    Description copied from class: ByteBuff
    
    Writes an int to this ByteBuff at its current position. Also advances the position by size of int.
    
    Specified by:
    
    putInt in class ByteBuff
  - getInt
```
public int getInt(int index)
```
    Description copied from class: ByteBuff
    
    Fetches the int at the given index. Does not change position of the underlying ByteBuffers. Even if the current int does not fit in the current item we can safely move to the next item and fetch the remaining bytes forming the int.
    
    Specified by:
    
    getInt in class ByteBuff
  - getIntAfterPosition
```
public int getIntAfterPosition(int offset)
```
    Description copied from class: ByteBuff
    
    Fetches the int value at the given offset from current position. Does not change position of the underlying ByteBuffers.
    
    Specified by:
    
    getIntAfterPosition in class ByteBuff
  - getLong
```
public long getLong()
```
    Description copied from class: ByteBuff
    
    Returns the long value at the current position. Also advances the position by the size of long.
    
    Specified by:
    
    getLong in class ByteBuff
  - putLong
```
public SingleByteBuff putLong(long value)
```
    Description copied from class: ByteBuff
    
    Writes a long to this ByteBuff at its current position. Also advances the position by size of long.
    
    Specified by:
    
    putLong in class ByteBuff
  - getLong
```
public long getLong(int index)
```
    Description copied from class: ByteBuff
    
    Fetches the long at the given index. Does not change position of the underlying ByteBuffers. The caller is sure that the index will be after the current position of this ByteBuff. So even if the current long does not fit in the current item we can safely move to the next item and fetch the remaining bytes forming the long n * @return the long value at the given index
    
    Specified by:
    
    getLong in class ByteBuff
  - getLongAfterPosition
```
public long getLongAfterPosition(int offset)
```
    Description copied from class: ByteBuff
    
    Fetches the long value at the given offset from current position. Does not change position of the underlying ByteBuffers. n * @return the long value at the given index.
    
    Specified by:
    
    getLongAfterPosition in class ByteBuff
  - toBytes
```
public byte[] toBytes(int offset,
                      int length)
```
    Description copied from class: ByteBuff
    
    Copy the content from this ByteBuff to a byte[] based on the given offset and length.
    
    Specified by:
    
    toBytes in class ByteBuff
  - get
```
public void get(ByteBuffer out,
                int sourceOffset,
                int length)
```
    Description copied from class: ByteBuff
    
    Copies the content from this ByteBuff to a ByteBuffer Note : This will advance the position marker of out but not change the position maker for this ByteBuff
    
    Specified by:
    
    get in class ByteBuff
    
    Parameters:
    
    out - the ByteBuffer to which the copy has to happen
    
    sourceOffset - the offset in the ByteBuff from which the elements has to be copied
    
    length - the length in this ByteBuff upto which the elements has to be copied
  - read
```
public int read(ReadableByteChannel channel)
         throws IOException
```
    Description copied from class: ByteBuff
    
    Reads bytes from the given channel into this ByteBuf.
    
    Specified by:
    
    read in class ByteBuff
    
    Throws:
    
    IOException
  - read
```
public int read(FileChannel channel,
                long offset)
         throws IOException
```
    Description copied from class: ByteBuff
    
    Reads bytes from FileChannel into this ByteBuff
    
    Specified by:
    
    read in class ByteBuff
    
    Throws:
    
    IOException
  - write
```
public int write(FileChannel channel,
                 long offset)
          throws IOException
```
    Description copied from class: ByteBuff
    
    Write this ByteBuff's data into target file
    
    Specified by:
    
    write in class ByteBuff
    
    Throws:
    
    IOException
  - nioByteBuffers
```
public ByteBuffer[] nioByteBuffers()
```
    Specified by:
    
    nioByteBuffers in class ByteBuff
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - retain
```
public SingleByteBuff retain()
```

Class SingleByteBuff

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.nio.ByteBuff

Field Summary

Fields inherited from class org.apache.hadoop.hbase.nio.ByteBuff

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.nio.ByteBuff

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hbase.nio.HBaseReferenceCounted

Field Detail

UNSAFE_AVAIL

UNSAFE_UNALIGNED

buf

unsafeOffset

unsafeRef

Constructor Detail

SingleByteBuff

SingleByteBuff

SingleByteBuff

Method Detail

position

position

skip

moveBack

capacity

limit

limit

rewind

mark

asSubByteBuffer

asSubByteBuffer

remaining

hasRemaining

reset

slice

duplicate

get

get

getByteAfterPosition

put

put

get

get

get

put

put

put

hasArray

array

arrayOffset

getShort

getShort

getShortAfterPosition

getInt

putInt

getInt

getIntAfterPosition

getLong

putLong

getLong

getLongAfterPosition

toBytes

get

read

read

write

nioByteBuffers

equals

hashCode

retain