ByteBuffer (Pkts Buffer Lib 3.0.10 API)

java.lang.Object
- io.pkts.buffer.BaseBuffer
- - io.pkts.buffer.AbstractBuffer
  - - io.pkts.buffer.ByteBuffer

All Implemented Interfaces:

Buffer, Cloneable
```
public final class ByteBuffer
extends AbstractBuffer
```
A buffer directly backed by a byte-array

Author:

jonas@jonasborjesson.com

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] buffer
The actual buffer
- Fields inherited from class io.pkts.buffer.AbstractBuffer
  lowerBoundary, markedReaderIndex, readerIndex, upperBoundary, writerIndex
- Fields inherited from class io.pkts.buffer.BaseBuffer
  CR, LF

Fields
Modifier and Type	Field and Description
`protected byte[]`	`buffer` The actual buffer

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ByteBuffer(byte[] buffer)`
`protected`	`ByteBuffer(int readerIndex, int lowerBoundary, int upperBoundary, byte[] buffer)`
`protected`	`ByteBuffer(int readerIndex, int lowerBoundary, int upperBoundary, int writerIndex, byte[] buffer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Buffer`	`clone()` Performs a deep clone of this object.
`String`	`dumpAsHex()` Dump the content of this buffer as a hex dump ala Wireshark.
`boolean`	`equals(Object other)` Check whether to buffers are considered to be equal.
`boolean`	`equalsIgnoreCase(Object other)`
`byte[]`	`getArray()` Get the backing array.
`byte`	`getByte(int index)` Get the byte at the index.
`void`	`getBytes(Buffer dst)` Same as calling `Buffer.getBytes(int, Buffer)` where the index is `Buffer.getReaderIndex()`.
`void`	`getBytes(byte[] dst)`
`void`	`getBytes(int index, Buffer dst)` Transfer this buffer's data to the destination buffer.
`void`	`getBytes(int index, ByteBuffer dst)`
`int`	`getInt(int index)` Get a 32-bit integer at the specified absolute index.
`byte[]`	`getRawArray()`
`short`	`getShort(int index)`
`short`	`getUnsignedByte(int index)`
`long`	`getUnsignedInt(int index)`
`int`	`getUnsignedShort(int index)`
`int`	`hashCode()`
`boolean`	`hasReadableBytes()` Checks whether this buffer has any bytes available for reading without blocking.
`boolean`	`hasWriteSupport()` The underlying subclass should override this if it has write support.
`boolean`	`isEmpty()` Check whether this buffer is empty or not.
`byte`	`peekByte()` Peak a head to see what the next byte is.
`byte`	`readByte()` Read the next byte, which will also increase the readerIndex by one.
`Buffer`	`readBytes(int length)` Read the requested number of bytes and increase the readerIndex with the corresponding number of bytes.
`void`	`readExternal(ObjectInput in)`
`int`	`readInt()` Read an int and will increase the reader index of this buffer by 4
`short`	`readShort()`
`long`	`readUnsignedInt()` Read an unsigned int and will increase the reader index of this buffer by 4
`int`	`readUnsignedShort()`
`void`	`setByte(int index, byte value)` Set the byte at given index to a new value
`void`	`setInt(int index, int value)`
`void`	`setUnsignedByte(int index, short value)`
`void`	`setUnsignedInt(int index, long value)`
`void`	`setUnsignedShort(int index, int value)`
`Buffer`	`slice(int start, int stop)` Get a slice of the buffer starting at `start` (inclusive) ending at `stop` (exclusive).
`String`	`toString()`
`long`	`unsignedInt(byte a, byte b, byte c, byte d)`
`void`	`write(byte b)` Write a byte to where the current writer index is pointing.
`void`	`write(byte[] bytes)`
`void`	`write(int value)`
`void`	`write(long value)`
`void`	`write(String s)` Same as `Buffer.write(String, String)` where the charset is set to "UTF-8"
`void`	`write(String s, String charset)` Write a string to this buffer using the specified charset to convert the String into bytes.
`void`	`writeAsString(int value)` Write the integer value to this `Buffer` as a String.
`void`	`writeAsString(long value)` Write the long value to this `Buffer` as a String.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class io.pkts.buffer.AbstractBuffer
capacity, checkIndex, checkWriterIndex, getLowerBoundary, getReadableBytes, getReaderIndex, getUpperBoundary, getWritableBytes, getWriterIndex, markReaderIndex, readUnsignedByte, resetReaderIndex, setReaderIndex, setWriterIndex, slice, slice

Methods inherited from class io.pkts.buffer.BaseBuffer
checkReadableBytes, checkReadableBytesSafe, checkWritableBytesSafe, hasWritableBytes, indexOf, indexOf, isByteInArray, parseToInt, parseToInt, readLine, readUntil, readUntil, readUntilDoubleCRLF, readUntilSafe, readUntilSingleCRLF

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

Methods inherited from interface io.pkts.buffer.Buffer
getBit, getBit0, getBit1, getBit2, getBit3, getBit4, getBit5, getBit6, getBit7, getByes, unsignedInt

- Field Detail
  - buffer
```
protected final byte[] buffer
```
    The actual buffer
- Constructor Detail
  - ByteBuffer
```
protected ByteBuffer(byte[] buffer)
```
  - ByteBuffer
```
protected ByteBuffer(int readerIndex,
                     int lowerBoundary,
                     int upperBoundary,
                     byte[] buffer)
```
  - ByteBuffer
```
protected ByteBuffer(int readerIndex,
                     int lowerBoundary,
                     int upperBoundary,
                     int writerIndex,
                     byte[] buffer)
```
- Method Detail
  - slice
```
public Buffer slice(int start,
                    int stop)
```
    Get a slice of the buffer starting at start (inclusive) ending at stop (exclusive). Hence, the new capacity of the buffer is stop - start
    
    Returns:
  - readBytes
```
public Buffer readBytes(int length)
                 throws IndexOutOfBoundsException
```
    Read the requested number of bytes and increase the readerIndex with the corresponding number of bytes. The new buffer and this buffer both share the same backing array so changing either one of them will affect the other.
    
    Returns:
    
    Throws:
    
    IndexOutOfBoundsException
  - hasReadableBytes
```
public boolean hasReadableBytes()
```
    Checks whether this buffer has any bytes available for reading without blocking. This is the same as Buffer.getReadableBytes() > 0
    
    Returns:
  - isEmpty
```
public boolean isEmpty()
```
    Check whether this buffer is empty or not. This is the same as !Buffer.hasReadableBytes()
    
    Returns:
  - getByte
```
public byte getByte(int index)
             throws IndexOutOfBoundsException
```
    Get the byte at the index. Note, depending on the underlying implementing buffer, this method may block and try and read the missing bytes off a stream. E.g., the InputStreamBuffer gets its bytes off of a InputStream so let's say you have read 10 bytes off of the stream already but ask to access the byte at index 20, we will try and ready an additional 10 bytes from the InputStream so we can return the byte at index 20.
    
    Returns:
    
    the byte at the specified index
    
    Throws:
    
    IndexOutOfBoundsException - in case the index is greater than the capacity of this buffer
  - write
```
public void write(byte b)
           throws IndexOutOfBoundsException
```
    Description copied from interface: Buffer
    
    Write a byte to where the current writer index is pointing. Note, many implementations may not support writing and if they don't, they will throw a WriteNotSupportedException
    
    Specified by:
    
    write in interface Buffer
    
    Overrides:
    
    write in class AbstractBuffer
    
    Throws:
    
    IndexOutOfBoundsException - in case there is no more space to write to (which includes those cases where the underlying implementation does not support writing)
  - write
```
public void write(byte[] bytes)
           throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - getArray
```
public byte[] getArray()
```
    Get the backing array.
    
    Returns:
  - getRawArray
```
public byte[] getRawArray()
```
  - readByte
```
public byte readByte()
              throws IndexOutOfBoundsException
```
    Read the next byte, which will also increase the readerIndex by one.
    
    Returns:
    
    the next byte
    
    Throws:
    
    IndexOutOfBoundsException - in case there is nothing left to read
  - peekByte
```
public byte peekByte()
              throws IndexOutOfBoundsException,
                     IOException
```
    Peak a head to see what the next byte is. This method will not change the readerIndex
    
    Returns:
    
    the next byte
    
    Throws:
    
    IndexOutOfBoundsException - in case there is nothing left to read
    
    IOException
  - unsignedInt
```
public long unsignedInt(byte a,
                        byte b,
                        byte c,
                        byte d)
```
  - readUnsignedInt
```
public long readUnsignedInt()
                     throws IndexOutOfBoundsException
```
    Read an unsigned int and will increase the reader index of this buffer by 4
    
    Returns:
    
    a long representing the unsigned int
    
    Throws:
    
    IndexOutOfBoundsException - in case there is not 4 bytes left to read
  - readInt
```
public int readInt()
            throws IndexOutOfBoundsException
```
    Read an int and will increase the reader index of this buffer by 4
    
    Returns:
    
    the int value
    
    Throws:
    
    IndexOutOfBoundsException - in case there is not 4 bytes left to read
  - readShort
```
public short readShort()
                throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - readUnsignedShort
```
public int readUnsignedShort()
```
  - getInt
```
public int getInt(int index)
```
    Get a 32-bit integer at the specified absolute index. This method will not modify the readerIndex of this buffer.
    
    Returns:
  - getShort
```
public short getShort(int index)
```
  - setUnsignedShort
```
public void setUnsignedShort(int index,
                             int value)
```
  - getUnsignedShort
```
public int getUnsignedShort(int index)
                     throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - getUnsignedInt
```
public long getUnsignedInt(int index)
                    throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - getUnsignedByte
```
public short getUnsignedByte(int index)
                      throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - dumpAsHex
```
public String dumpAsHex()
```
    Dump the content of this buffer as a hex dump ala Wireshark. Mainly for debugging purposes
    
    Returns:
  - clone
```
public Buffer clone()
```
    Performs a deep clone of this object. I.e., the array that is backed by this buffer will be copied and a new buffer will be returned. Hence, any changes to the backing of this buffer will not affect the cloned buffer.
    
    Specified by:
    
    clone in interface Buffer
    
    Specified by:
    
    clone in class AbstractBuffer
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Buffer
    
    Specified by:
    
    hashCode in class AbstractBuffer
  - equals
```
public boolean equals(Object other)
```
    Check whether to buffers are considered to be equal. To buffers are equal if the underlying visible area of the byte array are equal.
    
    Specified by:
    
    equals in interface Buffer
    
    Specified by:
    
    equals in class AbstractBuffer
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(Object other)
```
  - setByte
```
public void setByte(int index,
                    byte value)
             throws IndexOutOfBoundsException
```
    Set the byte at given index to a new value
    
    Parameters:
    
    index - the index
    
    value - the value
    
    Throws:
    
    IndexOutOfBoundsException
  - setUnsignedByte
```
public void setUnsignedByte(int index,
                            short value)
                     throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Buffer
    
    Overrides:
    
    toString in class Object
  - getBytes
```
public void getBytes(Buffer dst)
```
    Description copied from interface: Buffer
    
    Same as calling Buffer.getBytes(int, Buffer) where the index is Buffer.getReaderIndex().
  - getBytes
```
public void getBytes(int index,
                     Buffer dst)
```
    Description copied from interface: Buffer
    
    Transfer this buffer's data to the destination buffer. This method does not change the readerIndex or the writerIndex of the src buffer (i.e. this) but will increase the writerIndex of the destination buffer.
  - getBytes
```
public void getBytes(byte[] dst)
              throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - getBytes
```
public void getBytes(int index,
                     ByteBuffer dst)
```
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Throws:
    
    IOException
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Throws:
    
    IOException
    
    ClassNotFoundException
  - hasWriteSupport
```
public boolean hasWriteSupport()
```
    Description copied from class: AbstractBuffer
    
    The underlying subclass should override this if it has write support. Check whether this Buffer has write support or not. There are buffers that do not allow you to write to them (such as the EmptyBuffer) so if you try and write to such a buffer it will throw a WriteNotSupportedException.
    
    Specified by:
    
    hasWriteSupport in interface Buffer
    
    Overrides:
    
    hasWriteSupport in class AbstractBuffer
    
    Returns:
  - write
```
public void write(String s)
           throws IndexOutOfBoundsException,
                  WriteNotSupportedException,
                  UnsupportedEncodingException
```
    Description copied from interface: Buffer
    
    Same as Buffer.write(String, String) where the charset is set to "UTF-8"
    
    Specified by:
    
    write in interface Buffer
    
    Overrides:
    
    write in class AbstractBuffer
    
    Throws:
    
    IndexOutOfBoundsException - in case we cannot write entire String to this Buffer.
    
    WriteNotSupportedException - in case the underlying implementation does not support writes.
    
    UnsupportedEncodingException - in case the charset "UTF-8" is not supported by the platform.
  - write
```
public void write(String s,
                  String charset)
           throws IndexOutOfBoundsException,
                  WriteNotSupportedException,
                  UnsupportedEncodingException
```
    Description copied from interface: Buffer
    
    Write a string to this buffer using the specified charset to convert the String into bytes. The writerInxex of this buffer will be increased with the corresponding number of bytes. Note, either the entire string is written to this buffer or if it doesn't fit then nothing is written to this buffer.
    
    Specified by:
    
    write in interface Buffer
    
    Overrides:
    
    write in class AbstractBuffer
    
    Throws:
    
    IndexOutOfBoundsException - in case we cannot write entire String to this Buffer.
    
    WriteNotSupportedException
    
    UnsupportedEncodingException - in case the specified charset is not supported
  - setInt
```
public void setInt(int index,
                   int value)
            throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - setUnsignedInt
```
public void setUnsignedInt(int index,
                           long value)
                    throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - write
```
public void write(int value)
           throws IndexOutOfBoundsException,
                  WriteNotSupportedException
```
    Throws:
    
    IndexOutOfBoundsException
    
    WriteNotSupportedException
  - write
```
public void write(long value)
           throws IndexOutOfBoundsException,
                  WriteNotSupportedException
```
    Throws:
    
    IndexOutOfBoundsException
    
    WriteNotSupportedException
  - writeAsString
```
public void writeAsString(int value)
                   throws IndexOutOfBoundsException,
                          WriteNotSupportedException
```
    Description copied from interface: Buffer
    
    Write the integer value to this Buffer as a String.
    
    Parameters:
    
    value - the value that will be converted to a String before being written to this Buffer.
    
    Throws:
    
    IndexOutOfBoundsException
    
    WriteNotSupportedException
  - writeAsString
```
public void writeAsString(long value)
                   throws IndexOutOfBoundsException,
                          WriteNotSupportedException
```
    Description copied from interface: Buffer
    
    Write the long value to this Buffer as a String.
    
    Parameters:
    
    value - the value that will be converted to a String before being written to this Buffer.
    
    Throws:
    
    IndexOutOfBoundsException
    
    WriteNotSupportedException

Class ByteBuffer

Field Summary

Fields inherited from class io.pkts.buffer.AbstractBuffer

Fields inherited from class io.pkts.buffer.BaseBuffer

Constructor Summary

Method Summary

Methods inherited from class io.pkts.buffer.AbstractBuffer

Methods inherited from class io.pkts.buffer.BaseBuffer

Methods inherited from class java.lang.Object

Methods inherited from interface io.pkts.buffer.Buffer

Field Detail

buffer

Constructor Detail

ByteBuffer

ByteBuffer

ByteBuffer

Method Detail

slice

readBytes

hasReadableBytes

isEmpty

getByte

write

write

getArray

getRawArray

readByte

peekByte

unsignedInt

readUnsignedInt

readInt

readShort

readUnsignedShort

getInt

getShort

setUnsignedShort

getUnsignedShort

getUnsignedInt

getUnsignedByte

dumpAsHex

clone

hashCode

equals

equalsIgnoreCase

setByte

setUnsignedByte

toString

getBytes

getBytes

getBytes

getBytes

writeExternal

readExternal

hasWriteSupport

write

write

setInt

setUnsignedInt

write

write

writeAsString

writeAsString