io.pkts.buffer

Class ByteBuffer

java.lang.Object

io.pkts.buffer.AbstractBuffer

io.pkts.buffer.ByteBuffer

All Implemented Interfaces:

Buffer, java.lang.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

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

Modifier and Type	Method and Description
Buffer	clone() Performs a deep clone of this object.
java.lang.String	dumpAsHex() Dump the content of this buffer as a hex dump ala Wireshark.
boolean	equals(java.lang.Object other) Check whether to buffers are considered to be equal.
boolean	equalsIgnoreCase(java.lang.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(int index, Buffer dst) Transfer this buffer's data to the destination buffer.
void	getBytes(int index, java.nio.ByteBuffer dst)
int	getInt(int index) Get a 32-bit integer at the specified absolute index.
short	getShort(int index)
short	getUnsignedByte(int index)
int	getUnsignedShort(int index)
int	getWriterIndex() The writer 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(java.io.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).
java.lang.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(int value)
void	write(long value)
void	write(java.lang.String s) Same as Buffer.write(String, String) where the charset is set to "UTF-8"
void	write(java.lang.String s, java.lang.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(java.io.ObjectOutput out)

Methods inherited from class io.pkts.buffer.AbstractBuffer

capacity, checkIndex, checkReadableBytes, checkReadableBytesSafe, checkWritableBytesSafe, checkWriterIndex, getReadableBytes, getReaderIndex, getWritableBytes, hasWritableBytes, indexOf, indexOf, markReaderIndex, parseToInt, parseToInt, readLine, readUnsignedByte, readUntil, readUntil, readUntilDoubleCRLF, resetReaderIndex, setReaderIndex, slice, slice

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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 java.lang.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:

java.lang.IndexOutOfBoundsException

hasReadableBytes

public boolean hasReadableBytes()

Checks whether this buffer has any bytes available for reading without blocking. This is the same as #readableBytes > 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 java.lang.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:

java.lang.IndexOutOfBoundsException - in case the index is greater than the capacity of this buffer

write

public void write(byte b)
           throws java.lang.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:

java.lang.IndexOutOfBoundsException - in case there is no more space to write to (which includes those cases where the underlying implementation does not support writing)

getArray

public byte[] getArray()

Get the backing array.

Returns:

readByte

public byte readByte()
              throws java.lang.IndexOutOfBoundsException

Read the next byte, which will also increase the readerIndex by one.

Returns:

the next byte

Throws:

java.lang.IndexOutOfBoundsException - in case there is nothing left to read

peekByte

public byte peekByte()
              throws java.lang.IndexOutOfBoundsException,
                     java.io.IOException

Peak a head to see what the next byte is. This method will not change the readerIndex

Returns:

the next byte

Throws:

java.lang.IndexOutOfBoundsException - in case there is nothing left to read

java.io.IOException

unsignedInt

public long unsignedInt(byte a,
                        byte b,
                        byte c,
                        byte d)

readUnsignedInt

public long readUnsignedInt()
                     throws java.lang.IndexOutOfBoundsException

Read an unsigned int and will increase the reader index of this buffer by 4

Returns:

a long representing the unsigned int

Throws:

java.lang.IndexOutOfBoundsException - in case there is not 4 bytes left to read

readInt

public int readInt()
            throws java.lang.IndexOutOfBoundsException

Read an int and will increase the reader index of this buffer by 4

Returns:

the int value

Throws:

java.lang.IndexOutOfBoundsException - in case there is not 4 bytes left to read

readShort

public short readShort()
                throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.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 java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

getUnsignedByte

public short getUnsignedByte(int index)
                      throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

dumpAsHex

public java.lang.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(java.lang.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(java.lang.Object other)

setByte

public void setByte(int index,
                    byte value)
             throws java.lang.IndexOutOfBoundsException

Set the byte at given index to a new value

Parameters:

index - the index

value - the value

Throws:

java.lang.IndexOutOfBoundsException

setUnsignedByte

public void setUnsignedByte(int index,
                            short value)
                     throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

toString

public java.lang.String toString()

Specified by:

toString in interface Buffer

Overrides:

toString in class java.lang.Object

getWriterIndex

public int getWriterIndex()

Description copied from interface: Buffer

The writer index. This is where we will be writing our next byte if asked to do so.

Specified by:

getWriterIndex in interface Buffer

Overrides:

getWriterIndex in class AbstractBuffer

Returns:

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(int index,
                     java.nio.ByteBuffer dst)

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.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(java.lang.String s)
           throws java.lang.IndexOutOfBoundsException,
                  WriteNotSupportedException,
                  java.io.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:

java.lang.IndexOutOfBoundsException - in case we cannot write entire String to this Buffer.

WriteNotSupportedException - in case the underlying implementation does not support writes.

java.io.UnsupportedEncodingException - in case the charset "UTF-8" is not supported by the platform.

write

public void write(java.lang.String s,
                  java.lang.String charset)
           throws java.lang.IndexOutOfBoundsException,
                  WriteNotSupportedException,
                  java.io.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:

java.lang.IndexOutOfBoundsException - in case we cannot write entire String to this Buffer.

WriteNotSupportedException

java.io.UnsupportedEncodingException - in case the specified charset is not supported

setInt

public void setInt(int index,
                   int value)
            throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

setUnsignedInt

public void setUnsignedInt(int index,
                           long value)
                    throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

write

public void write(int value)
           throws java.lang.IndexOutOfBoundsException,
                  WriteNotSupportedException

Throws:

java.lang.IndexOutOfBoundsException

WriteNotSupportedException

write

public void write(long value)
           throws java.lang.IndexOutOfBoundsException,
                  WriteNotSupportedException

Throws:

java.lang.IndexOutOfBoundsException

WriteNotSupportedException

writeAsString

public void writeAsString(int value)
                   throws java.lang.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:

java.lang.IndexOutOfBoundsException

WriteNotSupportedException

writeAsString

public void writeAsString(long value)
                   throws java.lang.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:

java.lang.IndexOutOfBoundsException

WriteNotSupportedException