|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.util.LittleEndian
public class LittleEndian
a utility class for handling little-endian numbers, which the 80x86 world is replete with. The methods are all static, and input/output is from/to byte arrays, or from InputStreams.
| Nested Class Summary | |
|---|---|
static class |
LittleEndian.BufferUnderrunException
Exception to handle buffer underruns |
| Field Summary |
|---|
| Fields inherited from interface org.apache.poi.util.LittleEndianConsts |
|---|
BYTE_SIZE, DOUBLE_SIZE, INT_SIZE, LONG_SIZE, SHORT_SIZE |
| Method Summary | |
|---|---|
static byte[] |
getByteArray(byte[] data,
int offset,
int size)
Copy a portion of a byte array |
static double |
getDouble(byte[] data)
get a double value from the beginning of a byte array |
static double |
getDouble(byte[] data,
int offset)
get a double value from a byte array, reads it in little endian format then converts the resulting revolting IEEE 754 (curse them) floating point number to a happy java double |
static int |
getInt(byte[] data)
get an int value from the beginning of a byte array |
static int |
getInt(byte[] data,
int offset)
get an int value from a byte array |
static long |
getLong(byte[] data)
get a long value from the beginning of a byte array |
static long |
getLong(byte[] data,
int offset)
get a long value from a byte array |
static short |
getShort(byte[] data)
get a short value from the beginning of a byte array |
static short |
getShort(byte[] data,
int offset)
get a short value from a byte array |
static short[] |
getShortArray(byte[] data,
int offset)
get a short array from a byte array. |
static short[] |
getSimpleShortArray(byte[] data,
int offset,
int size)
get a short array from a byte array. |
static long |
getUInt(byte[] data)
get an unsigned int value from a byte array |
static long |
getUInt(byte[] data,
int offset)
get an unsigned int value from a byte array |
static long |
getULong(byte[] data,
int offset)
Gets an unsigned int value (8 bytes) from a byte array. |
static int |
getUnsignedByte(byte[] data)
get the unsigned value of a byte. |
static int |
getUnsignedByte(byte[] data,
int offset)
get the unsigned value of a byte. |
static int |
getUShort(byte[] data)
get an unsigned short value from the beginning of a byte array |
static int |
getUShort(byte[] data,
int offset)
get an unsigned short value from a byte array |
static void |
putDouble(byte[] data,
double value)
put a double value into beginning of a byte array |
static void |
putDouble(byte[] data,
int offset,
double value)
put a double value into a byte array |
static void |
putInt(byte[] data,
int value)
put an int value into beginning of a byte array |
static void |
putInt(byte[] data,
int offset,
int value)
put an int value into a byte array |
static void |
putLong(byte[] data,
int offset,
long value)
put a long value into a byte array |
static void |
putLong(byte[] data,
long value)
put a long value into beginning of a byte array |
static void |
putShort(byte[] data,
int offset,
short value)
put a short value into a byte array |
static void |
putShort(byte[] data,
short value)
put a short value into beginning of a byte array |
static void |
putShortArray(byte[] data,
int offset,
short[] value)
put a array of shorts into a byte array |
static void |
putUShort(byte[] data,
int offset,
int value)
put an unsigned short value into a byte array |
static byte[] |
readFromStream(java.io.InputStream stream,
int size)
Read the appropriate number of bytes from the stream and return them to the caller. |
static int |
readInt(java.io.InputStream stream)
get an int value from an InputStream |
static long |
readLong(java.io.InputStream stream)
get a long value from an InputStream |
static short |
readShort(java.io.InputStream stream)
get a short value from an InputStream |
static int |
ubyteToInt(byte b)
Convert an 'unsigned' byte to an integer. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public static short getShort(byte[] data,
int offset)
data - the byte arrayoffset - a starting offset into the byte array
public static int getUShort(byte[] data,
int offset)
data - the byte arrayoffset - a starting offset into the byte array
public static short[] getSimpleShortArray(byte[] data,
int offset,
int size)
data - Description of the Parameteroffset - Description of the Parametersize - Description of the Parameter
public static short[] getShortArray(byte[] data,
int offset)
data - Description of the Parameteroffset - Description of the Parameter
public static short getShort(byte[] data)
data - the byte array
public static int getUShort(byte[] data)
data - the byte array
public static int getInt(byte[] data,
int offset)
data - the byte arrayoffset - a starting offset into the byte array
public static int getInt(byte[] data)
data - the byte array
public static long getUInt(byte[] data,
int offset)
data - the byte arrayoffset - a starting offset into the byte array
public static long getUInt(byte[] data)
data - the byte array
public static long getLong(byte[] data,
int offset)
data - the byte arrayoffset - a starting offset into the byte array
public static long getLong(byte[] data)
data - the byte array
public static double getDouble(byte[] data,
int offset)
data - the byte arrayoffset - a starting offset into the byte array
public static double getDouble(byte[] data)
data - the byte array
public static void putShort(byte[] data,
int offset,
short value)
data - the byte arrayoffset - a starting offset into the byte arrayvalue - the short (16-bit) value
public static void putShortArray(byte[] data,
int offset,
short[] value)
data - the byte arrayoffset - a starting offset into the byte arrayvalue - the short array
public static void putUShort(byte[] data,
int offset,
int value)
data - the byte arrayoffset - a starting offset into the byte arrayvalue - the short (16-bit) value
java.lang.ArrayIndexOutOfBoundsException - may be thrown
public static void putShort(byte[] data,
short value)
data - the byte arrayvalue - the short (16-bit) value
public static void putInt(byte[] data,
int offset,
int value)
data - the byte arrayoffset - a starting offset into the byte arrayvalue - the int (32-bit) value
public static void putInt(byte[] data,
int value)
data - the byte arrayvalue - the int (32-bit) value
public static void putLong(byte[] data,
int offset,
long value)
data - the byte arrayoffset - a starting offset into the byte arrayvalue - the long (64-bit) value
public static void putLong(byte[] data,
long value)
data - the byte arrayvalue - the long (64-bit) value
public static void putDouble(byte[] data,
int offset,
double value)
data - the byte arrayoffset - a starting offset into the byte arrayvalue - the double (64-bit) value
public static void putDouble(byte[] data,
double value)
data - the byte arrayvalue - the double (64-bit) value
public static short readShort(java.io.InputStream stream)
throws java.io.IOException,
LittleEndian.BufferUnderrunException
stream - the InputStream from which the short
is to be read
java.io.IOException - will be propagated back to the caller
LittleEndian.BufferUnderrunException - if the stream cannot provide enough
bytes
public static int readInt(java.io.InputStream stream)
throws java.io.IOException,
LittleEndian.BufferUnderrunException
stream - the InputStream from which the int is
to be read
java.io.IOException - will be propagated back to the caller
LittleEndian.BufferUnderrunException - if the stream cannot provide enough
bytes
public static long readLong(java.io.InputStream stream)
throws java.io.IOException,
LittleEndian.BufferUnderrunException
stream - the InputStream from which the long
is to be read
java.io.IOException - will be propagated back to the caller
LittleEndian.BufferUnderrunException - if the stream cannot provide enough
bytes
public static byte[] readFromStream(java.io.InputStream stream,
int size)
throws java.io.IOException,
LittleEndian.BufferUnderrunException
However, for the purposes of the POI project, this risk is deemed negligible. It is, however, so noted.
stream - the InputStream we're reading fromsize - the number of bytes to read; in
99.99% of cases, this will be SHORT_SIZE, INT_SIZE, or LONG_SIZE --
but it doesn't have to be.
java.io.IOException - will be propagated back to the caller
LittleEndian.BufferUnderrunException - if the stream cannot provide enough
bytespublic static int ubyteToInt(byte b)
b - Description of the Parameter
public static int getUnsignedByte(byte[] data,
int offset)
data - the byte array.offset - a starting offset into the byte array.
public static int getUnsignedByte(byte[] data)
data - the byte array
public static byte[] getByteArray(byte[] data,
int offset,
int size)
data - the original byte arrayoffset - Where to start copying from.size - Number of bytes to copy.
java.lang.IndexOutOfBoundsException - - if copying would cause access of
data outside array bounds.
public static long getULong(byte[] data,
int offset)
Gets an unsigned int value (8 bytes) from a byte array.
data - the byte arrayoffset - a starting offset into the byte array
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||