org.alfresco.jlan.util

Class DataPacker

java.lang.Object

org.alfresco.jlan.util.DataPacker

public final class DataPacker
extends Object

The data packing class is a static class that is used to pack and unpack basic data types to/from network byte order and Intel byte order.

Author:

gkspencer

Constructor Summary

Constructors

Constructor and Description
DataPacker()

Method Summary

Modifier and Type	Method and Description
static int	getBufferPosition(int pos, String str, boolean uni, boolean nul) Calculate the new buffer position after the specified string and encoding (ASCII or Unicode)
static String	getDataString(char typ, byte[] bytarray, int pos, int maxlen, boolean uni) Unpack a null terminated data string from the data buffer.
static int	getInt(byte[] buf, int pos) Unpack a 32-bit integer.
static int	getIntelInt(byte[] bytarray, int pos) Unpack a 32-bit integer that is stored in Intel format.
static long	getIntelLong(byte[] bytarray, int pos) Unpack a 64-bit integer that is stored in Intel format.
static int	getIntelShort(byte[] bytarray, int pos) Unpack a 16-bit value that is stored in Intel format.
static long	getLong(byte[] buf, int pos) Unpack a 64-bit long.
static int	getShort(byte[] bytarray, int pos) Unpack a 16-bit value.
static String	getString(byte[] bytarray, int pos, int maxlen) Unpack a null terminated string from the data buffer.
static String	getString(byte[] bytarray, int pos, int maxlen, boolean isUni) Unpack a null terminated string from the data buffer.
static int	getStringLength(String str, boolean uni, boolean nul) Calculate the string length in bytes
static String	getUnicodeString(byte[] byt, int pos, int maxlen) Unpack a null terminated Unicode string from the data buffer.
static boolean	isBigEndian() Return the current endian setting.
static int	longwordAlign(int pos) Align a buffer offset on a longword boundary
static void	putInt(int val, byte[] bytarray, int pos) Pack a 32-bit integer into the supplied byte buffer.
static void	putIntelInt(int val, byte[] bytarray, int pos) Pack an 32-bit integer value in Intel format.
static void	putIntelLong(int val, byte[] bytarray, int pos) Pack a 64-bit integer value in Intel format.
static void	putIntelLong(long val, byte[] bytarray, int pos) Pack a 64-bit integer value in Intel format.
static void	putIntelShort(int val, byte[] bytarray, int pos) Pack a 16 bit value in Intel byte order.
static void	putLong(long val, byte[] bytarray, int pos) Pack a 64-bit integer value into the buffer
static void	putShort(int val, byte[] bytarray, int pos) Pack a 16-bit value into the supplied byte buffer.
static int	putString(String str, byte[] bytarray, int pos, boolean nullterm) Pack a string into a data buffer
static int	putString(String str, byte[] bytarray, int pos, boolean nullterm, boolean isUni) Pack a string into a data buffer.
static int	putString(String str, int fldLen, byte[] bytarray, int pos) Pack a string into a data buffer
static int	putUnicodeString(String str, byte[] bytarray, int pos, boolean nullterm) Pack a Unicode string into a data buffer
static void	putZeros(byte[] buf, int pos, int cnt) Pack nulls into the buffer.
static int	wordAlign(int pos) Align a buffer offset on a word boundary

Methods inherited from class java.lang.Object

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

Constructor Detail

DataPacker

public DataPacker()

Method Detail

isBigEndian

public static final boolean isBigEndian()

Return the current endian setting.

Returns:

true if the system is big endian, else false.

getDataString

public static final String getDataString(char typ,
                                         byte[] bytarray,
                                         int pos,
                                         int maxlen,
                                         boolean uni)

Unpack a null terminated data string from the data buffer.

Parameters:

typ - Data type, as specified by SMBDataType.

bytarray - Byte array to unpack the string value from.

pos - Offset to start unpacking the string value.

maxlen - Maximum length of data to be searched for a null character.

uni - String is Unicode if true, else ASCII

Returns:

String, else null if the terminating null character was not found.

getInt

public static final int getInt(byte[] buf,
                               int pos)
                        throws IndexOutOfBoundsException

Unpack a 32-bit integer.

Parameters:

buf - Byte buffer containing the integer to be unpacked.

pos - Position within the buffer that the integer is stored.

Returns:

The unpacked 32-bit integer value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

getIntelInt

public static final int getIntelInt(byte[] bytarray,
                                    int pos)
                             throws IndexOutOfBoundsException

Unpack a 32-bit integer that is stored in Intel format.

Parameters:

bytarray - Byte array containing the Intel integer to be unpacked.

pos - Offset that the Intel integer is stored within the byte array.

Returns:

Unpacked integer value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

getLong

public static final long getLong(byte[] buf,
                                 int pos)
                          throws IndexOutOfBoundsException

Unpack a 64-bit long.

Parameters:

buf - Byte buffer containing the integer to be unpacked.

pos - Position within the buffer that the integer is stored.

Returns:

The unpacked 64-bit long value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

getIntelLong

public static final long getIntelLong(byte[] bytarray,
                                      int pos)
                               throws IndexOutOfBoundsException

Unpack a 64-bit integer that is stored in Intel format.

Parameters:

bytarray - Byte array containing the Intel long to be unpacked.

pos - Offset that the Intel integer is stored within the byte array.

Returns:

Unpacked long value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

getIntelShort

public static final int getIntelShort(byte[] bytarray,
                                      int pos)
                               throws IndexOutOfBoundsException

Unpack a 16-bit value that is stored in Intel format.

Parameters:

bytarray - Byte array containing the short value to be unpacked.

pos - Offset to start unpacking the short value.

Returns:

Unpacked short value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

getShort

public static final int getShort(byte[] bytarray,
                                 int pos)
                          throws IndexOutOfBoundsException

Unpack a 16-bit value.

Parameters:

bytarray - Byte array containing the short to be unpacked.

pos - Offset within the byte array that the short is stored.

Returns:

Unpacked short value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

getString

public static final String getString(byte[] bytarray,
                                     int pos,
                                     int maxlen)

Unpack a null terminated string from the data buffer.

Parameters:

bytarray - Byte array to unpack the string value from.

pos - Offset to start unpacking the string value.

maxlen - Maximum length of data to be searched for a null character.

Returns:

String, else null if the terminating null character was not found.

getString

public static final String getString(byte[] bytarray,
                                     int pos,
                                     int maxlen,
                                     boolean isUni)

Unpack a null terminated string from the data buffer. The string may be ASCII or Unicode.

Parameters:

bytarray - Byte array to unpack the string value from.

pos - Offset to start unpacking the string value.

maxlen - Maximum length of data to be searched for a null character.

isUni - Unicode string if true, else ASCII string

Returns:

String, else null if the terminating null character was not found.

getUnicodeString

public static final String getUnicodeString(byte[] byt,
                                            int pos,
                                            int maxlen)

Unpack a null terminated Unicode string from the data buffer.

Parameters:

byt - Byte array to unpack the string value from.

pos - Offset to start unpacking the string value.

maxlen - Maximum length of data to be searched for a null character.

Returns:

String, else null if the terminating null character was not found.

putInt

public static final void putInt(int val,
                                byte[] bytarray,
                                int pos)
                         throws IndexOutOfBoundsException

Pack a 32-bit integer into the supplied byte buffer.

Parameters:

val - Integer value to be packed.

bytarray - Byte buffer to pack the integer value into.

pos - Offset to start packing the integer value.

Throws:

IndexOutOfBoundsException - If the buffer does not have enough space.

putIntelInt

public static final void putIntelInt(int val,
                                     byte[] bytarray,
                                     int pos)
                              throws IndexOutOfBoundsException

Pack an 32-bit integer value in Intel format.

Parameters:

val - Integer value to be packed.

bytarray - Byte array to pack the value into.

pos - Offset to start packing the integer value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

putLong

public static final void putLong(long val,
                                 byte[] bytarray,
                                 int pos)
                          throws IndexOutOfBoundsException

Pack a 64-bit integer value into the buffer

Parameters:

val - Integer value to be packed.

bytarray - Byte array to pack the value into.

pos - Offset to start packing the integer value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

putIntelLong

public static final void putIntelLong(long val,
                                      byte[] bytarray,
                                      int pos)
                               throws IndexOutOfBoundsException

Pack a 64-bit integer value in Intel format.

Parameters:

val - Integer value to be packed.

bytarray - Byte array to pack the value into.

pos - Offset to start packing the integer value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

putIntelLong

public static final void putIntelLong(int val,
                                      byte[] bytarray,
                                      int pos)
                               throws IndexOutOfBoundsException

Pack a 64-bit integer value in Intel format.

Parameters:

val - Integer value to be packed.

bytarray - Byte array to pack the value into.

pos - Offset to start packing the integer value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

putIntelShort

public static final void putIntelShort(int val,
                                       byte[] bytarray,
                                       int pos)
                                throws IndexOutOfBoundsException

Pack a 16 bit value in Intel byte order.

Parameters:

val - Short value to be packed.

bytarray - Byte array to pack the short value into.

pos - Offset to start packing the short value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

putShort

public static final void putShort(int val,
                                  byte[] bytarray,
                                  int pos)
                           throws IndexOutOfBoundsException

Pack a 16-bit value into the supplied byte buffer.

Parameters:

val - Short value to be packed.

bytarray - Byte array to pack the short value into.

pos - Offset to start packing the short value.

Throws:

IndexOutOfBoundsException - If there is not enough data in the buffer.

putString

public static final int putString(String str,
                                  byte[] bytarray,
                                  int pos,
                                  boolean nullterm)

Pack a string into a data buffer

Parameters:

str - String to be packed into the buffer

bytarray - Byte array to pack the string into

pos - Position to start packing the string

nullterm - true if the string should be null terminated, else false

Returns:

The ending buffer position

putString

public static final int putString(String str,
                                  int fldLen,
                                  byte[] bytarray,
                                  int pos)

Pack a string into a data buffer

Parameters:

str - String to be packed into the buffer

fldLen - Field length, will be space padded if short

bytarray - Byte array to pack the string into

pos - Position to start packing the string

Returns:

The ending buffer position

putString

public static final int putString(String str,
                                  byte[] bytarray,
                                  int pos,
                                  boolean nullterm,
                                  boolean isUni)

Pack a string into a data buffer. The string may be ASCII or Unicode.

Parameters:

str - String to be packed into the buffer

bytarray - Byte array to pack the string into

pos - Position to start packing the string

nullterm - true if the string should be null terminated, else false

isUni - true if the string should be packed as Unicode, false to pack as ASCII

Returns:

The ending buffer position

putUnicodeString

public static final int putUnicodeString(String str,
                                         byte[] bytarray,
                                         int pos,
                                         boolean nullterm)

Pack a Unicode string into a data buffer

Parameters:

str - String to be packed into the buffer

bytarray - Byte array to pack the string into

pos - Position to start packing the string

nullterm - true if the string should be null terminated, else false

Returns:

The ending buffer position

putZeros

public static final void putZeros(byte[] buf,
                                  int pos,
                                  int cnt)
                           throws ArrayIndexOutOfBoundsException

Pack nulls into the buffer.

Parameters:

buf - Buffer to pack data into.

pos - Position to start packing.

cnt - Number of nulls to pack.

Throws:

ArrayIndexOutOfBoundsException - If the buffer does not have enough space.

wordAlign

public static final int wordAlign(int pos)

Align a buffer offset on a word boundary

Parameters:

pos - int

Returns:

int

longwordAlign

public static final int longwordAlign(int pos)

Align a buffer offset on a longword boundary

Parameters:

pos - int

Returns:

int

getStringLength

public static final int getStringLength(String str,
                                        boolean uni,
                                        boolean nul)

Calculate the string length in bytes

Parameters:

str - String

uni - boolean

nul - boolean

Returns:

int

getBufferPosition

public static final int getBufferPosition(int pos,
                                          String str,
                                          boolean uni,
                                          boolean nul)

Calculate the new buffer position after the specified string and encoding (ASCII or Unicode)

Parameters:

pos - int

str - String

uni - boolean

nul - boolean

Returns:

int