| java.lang.Object
 org.apache.poi.util.LittleEndian
| LittleEndian | | public class LittleEndian implements LittleEndianConsts(Code) | | 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.
author:
Marc Johnson (mjohnson at apache dot org)
author:
Andrew Oliver (acoliver at apache dot org) |
| Inner Class :public static class BufferUnderrunException extends IOException | |
| Method Summary | |
| public static byte[] | getByteArray(byte[] data, int offset, int size)
Copy a portion of a byte array
Parameters:
data - the original byte array
Parameters:
offset - Where to start copying from.
Parameters:
size - Number of bytes to copy. | | public static double | getDouble(byte[] data, int offset)
| | public static double | getDouble(byte[] data)
| | public static int | getInt(byte[] data, int offset)
| | public static int | getInt(byte[] data)
| | public static long | getLong(byte[] data, int offset)
| | public static long | getLong(byte[] data)
| | public static short | getShort(byte[] data, int offset)
| | public static short | getShort(byte[] data)
| | public static short[] | getShortArray(byte[] data, int offset)
get a short array from a byte array. | | public static short[] | getSimpleShortArray(byte[] data, int offset, int size)
get a short array from a byte array. | | public static long | getUInt(byte[] data, int offset)
| | public static long | getUInt(byte[] data)
| | public static long | getULong(byte[] data, int offset)
| | public static int | getUShort(byte[] data, int offset)
| | public static int | getUShort(byte[] data)
| | public static int | getUnsignedByte(byte[] data, int offset)
get the unsigned value of a byte.
Parameters:
data - the byte array.
Parameters:
offset - a starting offset into the byte array. | | public static int | getUnsignedByte(byte[] data)
get the unsigned value of a byte. | | public static void | putDouble(byte[] data, int offset, double value)
| | public static void | putDouble(byte[] data, double value)
| | public static void | putInt(byte[] data, int offset, int value)
| | public static void | putInt(byte[] data, int value)
| | public static void | putLong(byte[] data, int offset, long value)
| | public static void | putLong(byte[] data, long value)
| | public static void | putShort(byte[] data, int offset, short value)
| | public static void | putShort(byte[] data, short value)
| | public static void | putShortArray(byte[] data, int offset, short[] value)
| | public static void | putUShort(byte[] data, int offset, int value)
| | public static byte[] | readFromStream(InputStream stream, int size)
Read the appropriate number of bytes from the stream and return them to
the caller. | | public static int | readInt(InputStream stream)
| | public static long | readLong(InputStream stream)
| | public static short | readShort(InputStream stream)
| | public static int | ubyteToInt(byte b)
Convert an 'unsigned' byte to an integer. |
| getByteArray | | public static byte[] getByteArray(byte[] data, int offset, int size)(Code) | | Copy a portion of a byte array
Parameters:
data - the original byte array
Parameters:
offset - Where to start copying from.
Parameters:
size - Number of bytes to copy. The byteArray value
throws:
IndexOutOfBoundsException - - if copying would cause access ofdata outside array bounds. |
| getDouble | | public static double getDouble(byte[] data, int offset)(Code) | | 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
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array the double (64-bit) value |
| getDouble | | public static double getDouble(byte[] data)(Code) | | get a double value from the beginning of a byte array
Parameters:
data - the byte array the double (64-bit) value |
| getInt | | public static int getInt(byte[] data, int offset)(Code) | | get an int value from a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array the int (32-bit) value |
| getInt | | public static int getInt(byte[] data)(Code) | | get an int value from the beginning of a byte array
Parameters:
data - the byte array the int (32-bit) value |
| getLong | | public static long getLong(byte[] data, int offset)(Code) | | get a long value from a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array the long (64-bit) value |
| getLong | | public static long getLong(byte[] data)(Code) | | get a long value from the beginning of a byte array
Parameters:
data - the byte array the long (64-bit) value |
| getShort | | public static short getShort(byte[] data, int offset)(Code) | | get a short value from a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array the short (16-bit) value |
| getShort | | public static short getShort(byte[] data)(Code) | | get a short value from the beginning of a byte array
Parameters:
data - the byte array the short (16-bit) value |
| getShortArray | | public static short[] getShortArray(byte[] data, int offset)(Code) | | get a short array from a byte array. The short array is assumed to start
with a word describing the length of the array.
Parameters:
data - Description of the Parameter
Parameters:
offset - Description of the Parameter The shortArray value |
| getSimpleShortArray | | public static short[] getSimpleShortArray(byte[] data, int offset, int size)(Code) | | get a short array from a byte array.
Parameters:
data - Description of the Parameter
Parameters:
offset - Description of the Parameter
Parameters:
size - Description of the Parameter The simpleShortArray value |
| getUInt | | public static long getUInt(byte[] data, int offset)(Code) | | get an unsigned int value from a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array the unsigned int (32-bit) value in a long |
| getUInt | | public static long getUInt(byte[] data)(Code) | | get an unsigned int value from a byte array
Parameters:
data - the byte array the unsigned int (32-bit) value in a long |
| getULong | | public static long getULong(byte[] data, int offset)(Code) | | Gets an unsigned int value (8 bytes) from a byte array.
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array the unsigned int (32-bit) value in a long |
| getUShort | | public static int getUShort(byte[] data, int offset)(Code) | | get an unsigned short value from a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array the unsigned short (16-bit) value in an integer |
| getUShort | | public static int getUShort(byte[] data)(Code) | | get an unsigned short value from the beginning of a byte array
Parameters:
data - the byte array the unsigned short (16-bit) value in an int |
| getUnsignedByte | | public static int getUnsignedByte(byte[] data, int offset)(Code) | | get the unsigned value of a byte.
Parameters:
data - the byte array.
Parameters:
offset - a starting offset into the byte array. the unsigned value of the byte as a 32 bit integer |
| getUnsignedByte | | public static int getUnsignedByte(byte[] data)(Code) | | get the unsigned value of a byte.
Parameters:
data - the byte array the unsigned value of the byte as a 32 bit integer |
| putDouble | | public static void putDouble(byte[] data, int offset, double value)(Code) | | put a double value into a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array
Parameters:
value - the double (64-bit) value |
| putDouble | | public static void putDouble(byte[] data, double value)(Code) | | put a double value into beginning of a byte array
Parameters:
data - the byte array
Parameters:
value - the double (64-bit) value |
| putInt | | public static void putInt(byte[] data, int offset, int value)(Code) | | put an int value into a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array
Parameters:
value - the int (32-bit) value |
| putInt | | public static void putInt(byte[] data, int value)(Code) | | put an int value into beginning of a byte array
Parameters:
data - the byte array
Parameters:
value - the int (32-bit) value |
| putLong | | public static void putLong(byte[] data, int offset, long value)(Code) | | put a long value into a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array
Parameters:
value - the long (64-bit) value |
| putLong | | public static void putLong(byte[] data, long value)(Code) | | put a long value into beginning of a byte array
Parameters:
data - the byte array
Parameters:
value - the long (64-bit) value |
| putShort | | public static void putShort(byte[] data, int offset, short value)(Code) | | put a short value into a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array
Parameters:
value - the short (16-bit) value |
| putShort | | public static void putShort(byte[] data, short value)(Code) | | put a short value into beginning of a byte array
Parameters:
data - the byte array
Parameters:
value - the short (16-bit) value |
| putShortArray | | public static void putShortArray(byte[] data, int offset, short[] value)(Code) | | put a array of shorts into a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array
Parameters:
value - the short array |
| putUShort | | public static void putUShort(byte[] data, int offset, int value)(Code) | | put an unsigned short value into a byte array
Parameters:
data - the byte array
Parameters:
offset - a starting offset into the byte array
Parameters:
value - the short (16-bit) value
exception:
ArrayIndexOutOfBoundsException - may be thrown |
| readFromStream | | public static byte[] readFromStream(InputStream stream, int size) throws IOException, BufferUnderrunException(Code) | | Read the appropriate number of bytes from the stream and return them to
the caller.
However, for the purposes of the POI project, this risk is deemed
negligible. It is, however, so noted.
Parameters:
stream - the InputStream we're reading from
Parameters:
size - the number of bytes to read; in99.99% of cases, this will be SHORT_SIZE, INT_SIZE, or LONG_SIZE --but it doesn't have to be. the byte array containing therequired number of bytes. The array will contain all zero's on endof stream
exception:
IOException - will be propagated back to the caller
exception:
BufferUnderrunException - if the stream cannot provide enoughbytes |
| readInt | | public static int readInt(InputStream stream) throws IOException, BufferUnderrunException(Code) | | get an int value from an InputStream
Parameters:
stream - the InputStream from which the int isto be read the int (32-bit) value
exception:
IOException - will be propagated back to the caller
exception:
BufferUnderrunException - if the stream cannot provide enoughbytes |
| readLong | | public static long readLong(InputStream stream) throws IOException, BufferUnderrunException(Code) | | get a long value from an InputStream
Parameters:
stream - the InputStream from which the longis to be read the long (64-bit) value
exception:
IOException - will be propagated back to the caller
exception:
BufferUnderrunException - if the stream cannot provide enoughbytes |
| readShort | | public static short readShort(InputStream stream) throws IOException, BufferUnderrunException(Code) | | get a short value from an InputStream
Parameters:
stream - the InputStream from which the shortis to be read the short (16-bit) value
exception:
IOException - will be propagated back to the caller
exception:
BufferUnderrunException - if the stream cannot provide enoughbytes |
| ubyteToInt | | public static int ubyteToInt(byte b)(Code) | | Convert an 'unsigned' byte to an integer. ie, don't carry across the
sign.
Parameters:
b - Description of the Parameter Description of the Return Value |
|
|