Module com.io7m.jintegers.core

Package com.io7m.jintegers

Class Signed32

java.lang.Object

com.io7m.jintegers.Signed32

public final class Signed32
extends Object

32-bit integer packing/unpacking functions.

Method Summary

Modifier and Type	Method	Description
static ByteBuffer	packToBuffer(int i, ByteBuffer r, int index)	Pack i into a byte buffer r using the encoding returned by ByteBuffer.order(), starting at index.
static ByteBuffer	packToBufferBigEndian(int i, ByteBuffer r, int index)	Pack i into a byte buffer r using a big-endian encoding such that the most significant byte is in r[index].
static ByteBuffer	packToBufferLittleEndian(int i, ByteBuffer r, int index)	Pack i into a byte buffer r using a little-endian encoding such that the least significant byte is in r[index].
static byte[]	packToBytesBigEndian(int i, byte[] r)	Pack i into a byte buffer r using a big-endian encoding such that the most significant byte is in r[0].
static byte[]	packToBytesBigEndianAllocate(int i)	Pack i into a byte buffer b using a big-endian encoding such that the most significant byte is in b[0].
static byte[]	packToBytesLittleEndian(int i, byte[] r)	Pack i into a byte buffer r using a little-endian encoding such that the least significant byte is in r[0].
static byte[]	packToBytesLittleEndianAllocate(int i)	Pack i into a byte buffer b using a little-endian encoding such that the least significant byte is in b[0].
static int	unpackFromBuffer(ByteBuffer buffer, int index)	Unpack an integer from buffer using the encoding returned by ByteBuffer.order(), starting at index.
static int	unpackFromBufferBigEndian(ByteBuffer buffer, int index)	Unpack an integer from buffer assuming a big-endian encoding such that the most significant byte is in b[index].
static int	unpackFromBufferLittleEndian(ByteBuffer buffer, int index)	Unpack an integer from buffer assuming a little-endian encoding such that the least significant byte is in b[index] .
static int	unpackFromBytesBigEndian(byte[] buffer)	Unpack an integer from buffer assuming a big-endian encoding such that the most significant byte is in b[0].
static int	unpackFromBytesLittleEndian(byte[] buffer)	Unpack an integer from buffer assuming a little-endian encoding such that the least significant byte is in b[0].

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

packToBytesBigEndianAllocate

public static byte[] packToBytesBigEndianAllocate(int i)

Pack i into a byte buffer b using a big-endian encoding such that the most significant byte is in b[0].

Parameters:

i - The value to be packed.

Returns:

A byte buffer containing the packed integer data.

packToBytesBigEndian

public static byte[] packToBytesBigEndian(int i,
                                          byte[] r)

Pack i into a byte buffer r using a big-endian encoding such that the most significant byte is in r[0].

Parameters:

r - The buffer

i - The value to be packed.

Returns:

A byte buffer containing the packed integer data.

packToBufferBigEndian

public static ByteBuffer packToBufferBigEndian(int i,
                                               ByteBuffer r,
                                               int index)

Pack i into a byte buffer r using a big-endian encoding such that the most significant byte is in r[index].

Parameters:

r - The buffer.

i - The value to be packed.

index - The starting index.

Returns:

r

packToBytesLittleEndianAllocate

public static byte[] packToBytesLittleEndianAllocate(int i)

Pack i into a byte buffer b using a little-endian encoding such that the least significant byte is in b[0].

Parameters:

i - The value to be packed.

Returns:

A byte buffer containing the packed integer data.

packToBytesLittleEndian

public static byte[] packToBytesLittleEndian(int i,
                                             byte[] r)

Pack i into a byte buffer r using a little-endian encoding such that the least significant byte is in r[0].

Parameters:

r - The buffer

i - The value to be packed.

Returns:

r

packToBufferLittleEndian

public static ByteBuffer packToBufferLittleEndian(int i,
                                                  ByteBuffer r,
                                                  int index)

Pack i into a byte buffer r using a little-endian encoding such that the least significant byte is in r[index].

Parameters:

r - The buffer.

i - The value to be packed.

index - The starting index.

Returns:

r

packToBuffer

public static ByteBuffer packToBuffer(int i,
                                      ByteBuffer r,
                                      int index)

Pack i into a byte buffer r using the encoding returned by ByteBuffer.order(), starting at index.

Parameters:

r - The buffer.

i - The value to be packed.

index - The starting index.

Returns:

r

unpackFromBytesBigEndian

public static int unpackFromBytesBigEndian(byte[] buffer)

Unpack an integer from buffer assuming a big-endian encoding such that the most significant byte is in b[0].

The function throws NullPointerException if buffer == null and IllegalArgumentException if buffer.length is too small to contain a packed integer value of this size.

Parameters:

buffer - The buffer from which to unpack data

Returns:

A 32 bit integer value

unpackFromBufferBigEndian

public static int unpackFromBufferBigEndian(ByteBuffer buffer,
                                            int index)

Unpack an integer from buffer assuming a big-endian encoding such that the most significant byte is in b[index].

Parameters:

index - The starting index in the buffer.

buffer - The buffer from which to unpack data.

Returns:

A 32 bit integer value.

unpackFromBuffer

public static int unpackFromBuffer(ByteBuffer buffer,
                                   int index)

Unpack an integer from buffer using the encoding returned by ByteBuffer.order(), starting at index.

Parameters:

index - The starting index

buffer - The buffer from which to unpack data.

Returns:

A 32 bit integer value.

unpackFromBytesLittleEndian

public static int unpackFromBytesLittleEndian(byte[] buffer)

Unpack an integer from buffer assuming a little-endian encoding such that the least significant byte is in b[0].

The function throws NullPointerException if buffer == null and IllegalArgumentException if buffer.length is too small to contain a packed integer value of this size.

Parameters:

buffer - The buffer from which to unpack data

Returns:

A 32 bit integer value

unpackFromBufferLittleEndian

public static int unpackFromBufferLittleEndian(ByteBuffer buffer,
                                               int index)

Unpack an integer from buffer assuming a little-endian encoding such that the least significant byte is in b[index] .

Parameters:

index - The starting index

buffer - The buffer from which to unpack data.

Returns:

A 32 bit integer value.