org.jlab.coda.jevio

Class ByteDataTransformer

java.lang.Object

org.jlab.coda.jevio.ByteDataTransformer

public class ByteDataTransformer
extends java.lang.Object

This utility class contains methods for transforming a raw byte array into arrays of other types and vice versa as well as other handy methods.

Author:

heddle, timmer, wolin

Constructor Summary

Constructors

Constructor and Description
ByteDataTransformer()

Method Summary

Modifier and Type	Method and Description
static int	byteBitsToInt(byte byteVal) Copies a 1-byte byte value into a 4-byte int while preserving bit pattern.
static double[]	getAsDoubleArray(byte[] bytes, java.nio.ByteOrder byteOrder) Deprecated.
static float[]	getAsFloatArray(byte[] bytes, java.nio.ByteOrder byteOrder) Deprecated.
static int[]	getAsIntArray(byte[] bytes, java.nio.ByteOrder byteOrder) Deprecated.
static long[]	getAsLongArray(byte[] bytes, java.nio.ByteOrder byteOrder) Deprecated.
static short[]	getAsShortArray(byte[] bytes, java.nio.ByteOrder byteOrder) Deprecated.
static short[]	getAsShortArray(byte[] bytes, int padding, java.nio.ByteOrder byteOrder) Deprecated.
static void	intoByteBuffer(int[] data, int dataOffset, int dataLen, java.nio.ByteBuffer buffer) Write int array into ByteBuffer.
static void	intToBytes(int intVal, byte[] b, int off) Copies an integer value into 4 bytes of a byte array.
static int	shortBitsToInt(short shortVal) Copies a 2-byte short value into a 4-byte int while preserving bit pattern.
static void	shortToBytes(short val, byte[] b, int off) Copies a short value into 2 bytes of a byte array.
static void	swapArray32(byte[] data, int dataOffset, int dataLen) Swap byte array in place assuming bytes are 32 bit ints.
(package private) static void	swapBankHeader(EvioNode node, java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer destBuffer, int srcPos, int destPos) This method reads and swaps an evio bank header.
(package private) static void	swapData(DataType type, java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer destBuffer, int srcPos, int destPos, int len, boolean inPlace) This method swaps the data of an evio leaf structure.
static void	swapEvent(java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer destBuffer, int srcPos, int destPos) This method swaps the byte order of an entire evio event or bank.
static void	swapEvent(java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer destBuffer, int srcPos, int destPos, boolean swapData, java.util.List<EvioNode> nodeList) This method swaps the byte order of an entire evio event or bank.
static void	swapEvent(java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer destBuffer, int srcPos, int destPos, java.util.List<EvioNode> nodeList) This method swaps the byte order of an entire evio event or bank.
(package private) static void	swapSegmentHeader(EvioNode node, java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer destBuffer, int srcPos, int destPos) This method reads and swaps an evio segment header.
(package private) static void	swapStructure(EvioNode node, java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer destBuffer, int srcPos, int destPos, boolean inPlace, boolean swapData, java.util.List<EvioNode> nodeList) Swap an evio structure.
(package private) static void	swapTagSegmentHeader(EvioNode node, java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer destBuffer, int srcPos, int destPos) This method reads and swaps an evio tagsegment header.
static void	toBitSet(java.util.BitSet bSet, int bits) Converts an integer into a BitSet object.
static byte[]	toByteArray(java.nio.ByteBuffer byteBuffer) Converts an ByteBuffer object into a byte array.
static byte[]	toBytes(double[] data, java.nio.ByteOrder byteOrder) Turn double array into byte array.
static void	toBytes(double[] data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn double array into byte array.
static byte[]	toBytes(double data, java.nio.ByteOrder byteOrder) Turn double into byte array.
static void	toBytes(double data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn double into byte array.
static byte[]	toBytes(float[] data, java.nio.ByteOrder byteOrder) Turn float array into byte array.
static void	toBytes(float[] data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn float array into byte array.
static byte[]	toBytes(float data, java.nio.ByteOrder byteOrder) Turn float into byte array.
static void	toBytes(float data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn float into byte array.
static byte[]	toBytes(int[] data, java.nio.ByteOrder byteOrder) Turn int array into byte array.
static void	toBytes(int[] data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn int array into byte array.
static byte[]	toBytes(int[] data, int offset, int length, java.nio.ByteOrder byteOrder) Turn int array into byte array.
static void	toBytes(int[] data, int dataOff, int dataLen, java.nio.ByteOrder byteOrder, byte[] dest, int off) Write int array into byte array.
static byte[]	toBytes(int data, java.nio.ByteOrder byteOrder) Turn int into byte array.
static void	toBytes(int data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn int into byte array.
static byte[]	toBytes(long[] data, java.nio.ByteOrder byteOrder) Turn long array into byte array.
static void	toBytes(long[] data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn long array into byte array.
static byte[]	toBytes(long data, java.nio.ByteOrder byteOrder) Turn long into byte array.
static void	toBytes(long data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn long into byte array.
static byte[]	toBytes(short[] data, java.nio.ByteOrder byteOrder) Turn short array into byte array.
static void	toBytes(short[] data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn short array into byte array.
static byte[]	toBytes(short data, java.nio.ByteOrder byteOrder) Turn short into byte array.
static void	toBytes(short data, java.nio.ByteOrder byteOrder, byte[] dest, int off) Turn short into byte array.
static byte[]	toBytesStream(int[] data, java.nio.ByteOrder byteOrder) Turn int array into byte array.
static double	toDouble(byte[] data, java.nio.ByteOrder byteOrder, int off) Turn section of byte array into a double.
static double	toDouble(byte b1, byte b2, byte b3, byte b4, byte b5, byte b6, byte b7, byte b8, java.nio.ByteOrder byteOrder) Turn 8 bytes into a double.
static double[]	toDoubleArray(byte[] data, java.nio.ByteOrder byteOrder) Turn byte array into a double array.
static void	toDoubleArray(byte[] data, java.nio.ByteOrder byteOrder, double[] dest, int off) Turn byte array into an double array.
static double[]	toDoubleArray(java.nio.ByteBuffer byteBuffer) Converts an ByteBuffer object into a double array.
static float	toFloat(byte[] data, java.nio.ByteOrder byteOrder, int off) Turn section of byte array into a float.
static float	toFloat(byte b1, byte b2, byte b3, byte b4, java.nio.ByteOrder byteOrder) Turn 4 bytes into a float.
static float[]	toFloatArray(byte[] data, java.nio.ByteOrder byteOrder) Turn byte array into a float array.
static void	toFloatArray(byte[] data, java.nio.ByteOrder byteOrder, float[] dest, int off) Turn byte array into an float array.
static float[]	toFloatArray(java.nio.ByteBuffer byteBuffer) Converts an ByteBuffer object into a float array.
static int	toInt(java.util.BitSet bSet) Converts a BitSet object into an integer.
static int	toInt(byte[] data, java.nio.ByteOrder byteOrder, int off) Turn section of byte array into an int.
static int	toInt(byte b1, byte b2, byte b3, byte b4, java.nio.ByteOrder byteOrder) Turn 4 bytes into an int.
static int[]	toIntArray(byte[] data, java.nio.ByteOrder byteOrder) Turn byte array into an int array.
static void	toIntArray(byte[] data, java.nio.ByteOrder byteOrder, int[] dest, int off) Turn byte array into an int array.
static void	toIntArray(byte[] data, int dataOffset, java.nio.ByteOrder byteOrder, int[] dest, int destOffset) Turn byte array into an int array.
static void	toIntArray(byte[] data, int dataOffset, int dataLen, java.nio.ByteOrder byteOrder, int[] dest, int destOffset) Turn byte array into an int array.
static int[]	toIntArray(java.nio.ByteBuffer byteBuffer) Converts an ByteBuffer object into an int array.
static int	toIntArray(java.nio.ByteBuffer byteBuffer, int[] dest) Writes ByteBuffer data into an int array.
static long	toLong(byte[] data, java.nio.ByteOrder byteOrder, int off) Turn section of byte array into a long.
static long	toLong(byte b1, byte b2, byte b3, byte b4, byte b5, byte b6, byte b7, byte b8, java.nio.ByteOrder byteOrder) Turn 8 bytes into a long.
static long[]	toLongArray(byte[] data, java.nio.ByteOrder byteOrder) Turn byte array into a long array.
static void	toLongArray(byte[] data, java.nio.ByteOrder byteOrder, long[] dest, int off) Turn byte array into an long array.
static long[]	toLongArray(java.nio.ByteBuffer byteBuffer) Converts an ByteBuffer object into a long array.
static short	toShort(byte[] data, java.nio.ByteOrder byteOrder, int off) Turn section of byte array into a short.
static short	toShort(byte b1, byte b2, java.nio.ByteOrder byteOrder) Turn 2 bytes into a short.
static short[]	toShortArray(byte[] data, java.nio.ByteOrder byteOrder) Turn byte array into a short array.
static void	toShortArray(byte[] data, java.nio.ByteOrder byteOrder, short[] dest, int off) Turn byte array into an short array.
static short[]	toShortArray(byte[] data, int padding, java.nio.ByteOrder byteOrder) Turn byte array into a short array while taking padding into account.
static void	toShortArray(byte[] data, int padding, java.nio.ByteOrder byteOrder, short[] dest, int off) Turn byte array into a short array while taking padding into account.
static short[]	toShortArray(java.nio.ByteBuffer byteBuffer) Converts an ByteBuffer object into a short array.
static java.lang.String[]	toStringArray(java.nio.ByteBuffer byteBuffer) Converts an ByteBuffer object containing evio String data into a String array.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteDataTransformer

public ByteDataTransformer()

Method Detail

toInt

public static int toInt(java.util.BitSet bSet)
                 throws EvioException

Converts a BitSet object into an integer.

Parameters:

bSet - BitSet to convert to integer.

Returns:

integer representing bit set values.

Throws:

EvioException - if arg null or contains too many true bits to fit into integer.

toBitSet

public static void toBitSet(java.util.BitSet bSet,
                            int bits)
                     throws EvioException

Converts an integer into a BitSet object.

Parameters:

bSet - BitSet object to hold int data.

bits - integer to convert to BitSet.

Throws:

EvioException - if arg null.

getAsIntArray

@Deprecated
public static int[] getAsIntArray(byte[] bytes,
                                              java.nio.ByteOrder byteOrder)

Deprecated.

Converts a byte array into an int array. Use toIntArray(byte[], java.nio.ByteOrder) for better performance.

Parameters:

bytes - the byte array.

byteOrder - the endianness of the data in the byte array, ByteOrder.BIG_ENDIAN or ByteOrder.LITTLE_ENDIAN.

Returns:

the raw bytes converted into an int array.

getAsShortArray

@Deprecated
public static short[] getAsShortArray(byte[] bytes,
                                                  java.nio.ByteOrder byteOrder)

Deprecated.

Converts a byte array into an short array. Use toShortArray(byte[], java.nio.ByteOrder) for better performance.

Parameters:

bytes - the byte array.

byteOrder - the endianness of the data in the byte array, ByteOrder.BIG_ENDIAN or ByteOrder.LITTLE_ENDIAN.

Returns:

the raw bytes converted into an int array.

getAsShortArray

@Deprecated
public static short[] getAsShortArray(byte[] bytes,
                                                  int padding,
                                                  java.nio.ByteOrder byteOrder)

Deprecated.

Converts a byte array into an short array while accounting for padding. Use toShortArray(byte[], int, java.nio.ByteOrder) for better performance.

Parameters:

bytes - the byte array.

padding - number of bytes at the end of the byte array to ignore. Valid values are 0 and multiples of 2 (though only 0 and 2 are used).

byteOrder - the endianness of the data in the byte array, ByteOrder.BIG_ENDIAN or ByteOrder.LITTLE_ENDIAN.

Returns:

the raw bytes converted into an int array.

getAsLongArray

@Deprecated
public static long[] getAsLongArray(byte[] bytes,
                                                java.nio.ByteOrder byteOrder)

Deprecated.

Converts a byte array into a long array. Use toLongArray(byte[], java.nio.ByteOrder) for better performance.

Parameters:

bytes - the byte array.

byteOrder - the endianness of the data in the byte array, ByteOrder.BIG_ENDIAN or ByteOrder.LITTLE_ENDIAN.

Returns:

the raw bytes converted into a long array.

getAsDoubleArray

@Deprecated
public static double[] getAsDoubleArray(byte[] bytes,
                                                    java.nio.ByteOrder byteOrder)

Deprecated.

Converts a byte array into a double array. Use toDoubleArray(byte[], java.nio.ByteOrder) for better performance.

Parameters:

bytes - the byte array.

byteOrder - the endianness of the data in the byte array, ByteOrder.BIG_ENDIAN or ByteOrder.LITTLE_ENDIAN.

Returns:

the raw bytes converted into a double array.

getAsFloatArray

@Deprecated
public static float[] getAsFloatArray(byte[] bytes,
                                                  java.nio.ByteOrder byteOrder)

Deprecated.

Converts a byte array into a float array. Use toFloatArray(byte[], java.nio.ByteOrder) for better performance.

Parameters:

bytes - the byte array.

byteOrder - the endianness of the data in the byte array, ByteOrder.BIG_ENDIAN or ByteOrder.LITTLE_ENDIAN.

Returns:

the raw bytes converted into a float array.

shortBitsToInt

public static final int shortBitsToInt(short shortVal)

Copies a 2-byte short value into a 4-byte int while preserving bit pattern. In other words, it treats the short as an unsigned value. The resulting int does NOT undergo sign extension (bits of highest 2 bytes are not all ones), and will not be a negative number.

Parameters:

shortVal - short value considered to be unsigned

Returns:

the equivalent int value

byteBitsToInt

public static final int byteBitsToInt(byte byteVal)

Copies a 1-byte byte value into a 4-byte int while preserving bit pattern. In other words, it treats the byte as an unsigned value. The resulting int does NOT undergo sign extension (bits of highest 3 bytes are not all ones), and will not be a negative number.

Parameters:

byteVal - byte value considered to be unsigned

Returns:

the equivalent int value

toByteArray

public static byte[] toByteArray(java.nio.ByteBuffer byteBuffer)

Converts an ByteBuffer object into a byte array. Copy is made of the data. Does change the position of the byteBuffer arg temporarily.

Parameters:

byteBuffer - the buffer to convert.

Returns:

the ByteBuffer converted into a byte array.

toIntArray

public static int[] toIntArray(java.nio.ByteBuffer byteBuffer)

Converts an ByteBuffer object into an int array. If length not a multiple of 4 bytes, ignore up to last 3 bytes.

Parameters:

byteBuffer - the buffer to convert.

Returns:

the int array containing byteBuffer's data.

toIntArray

public static int toIntArray(java.nio.ByteBuffer byteBuffer,
                             int[] dest)
                      throws EvioException

Writes ByteBuffer data into an int array. Provide the int array to avoid its allocation. If length not a multiple of 4 bytes, ignore up to last 3 bytes.

Parameters:

byteBuffer - the buffer to convert.

dest - array in which to put buffer data.

Returns:

number of integers in the dest array filled with valid data.

Throws:

EvioException - if bad args or dest cannot hold all of byteBuffer's data (from position to limit).

toShortArray

public static short[] toShortArray(java.nio.ByteBuffer byteBuffer)

Converts an ByteBuffer object into a short array.

Parameters:

byteBuffer - the buffer to convert.

Returns:

the ByteBuffer converted into a short array.

toLongArray

public static long[] toLongArray(java.nio.ByteBuffer byteBuffer)

Converts an ByteBuffer object into a long array.

Parameters:

byteBuffer - the buffer to convert.

Returns:

the ByteBuffer converted into a long array.

toFloatArray

public static float[] toFloatArray(java.nio.ByteBuffer byteBuffer)

Converts an ByteBuffer object into a float array.

Parameters:

byteBuffer - the buffer to convert.

Returns:

the ByteBuffer converted into a float array.

toDoubleArray

public static double[] toDoubleArray(java.nio.ByteBuffer byteBuffer)

Converts an ByteBuffer object into a double array.

Parameters:

byteBuffer - the buffer to convert.

Returns:

the ByteBuffer converted into a double array.

toStringArray

public static java.lang.String[] toStringArray(java.nio.ByteBuffer byteBuffer)

Converts an ByteBuffer object containing evio String data into a String array.

Parameters:

byteBuffer - the buffer to convert.

Returns:

the ByteBuffer converted into a String array; null if bad format.

intoByteBuffer

public static void intoByteBuffer(int[] data,
                                  int dataOffset,
                                  int dataLen,
                                  java.nio.ByteBuffer buffer)
                           throws EvioException

Write int array into ByteBuffer.

Parameters:

data - int data to write

dataOffset - offset into data array

dataLen - number of ints to write

buffer - buffer in which to write data

Throws:

EvioException - if data is null, buffer is null or too small, or offset out of bounds;

intToBytes

public static final void intToBytes(int intVal,
                                    byte[] b,
                                    int off)

Copies an integer value into 4 bytes of a byte array.

Parameters:

intVal - integer value

b - byte array

off - offset into the byte array

shortToBytes

public static final void shortToBytes(short val,
                                      byte[] b,
                                      int off)

Copies a short value into 2 bytes of a byte array.

Parameters:

val - short value

b - byte array

off - offset into the byte array

toBytes

public static byte[] toBytes(short data,
                             java.nio.ByteOrder byteOrder)

Turn short into byte array.

Parameters:

data - short to convert

byteOrder - byte order of returned byte array (big endian if null)

Returns:

byte array representing short

toBytes

public static void toBytes(short data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn short into byte array. Avoids creation of new byte array with each call.

Parameters:

data - short to convert

byteOrder - byte order of returned bytes (big endian if null)

dest - array in which to store returned bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if dest is null or too small or offset negative

toBytes

public static byte[] toBytes(short[] data,
                             java.nio.ByteOrder byteOrder)
                      throws EvioException

Turn short array into byte array.

Parameters:

data - short array to convert

byteOrder - byte order of returned bytes (big endian if null)

Returns:

byte array representing short array or null if data is null

Throws:

EvioException - if data array has too many elements to convert to a byte array

toBytes

public static void toBytes(short[] data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn short array into byte array. Avoids creation of new byte array with each call.

Parameters:

data - short array to convert

byteOrder - byte order of written bytes (big endian if null)

dest - array in which to store written bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if data is null, dest is null or too small, or offset negative; if data array has too many elements to convert to a byte array

toBytes

public static byte[] toBytes(int data,
                             java.nio.ByteOrder byteOrder)

Turn int into byte array.

Parameters:

data - int to convert

byteOrder - byte order of returned byte array (big endian if null)

Returns:

byte array representing int

toBytes

public static void toBytes(int data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn int into byte array. Avoids creation of new byte array with each call.

Parameters:

data - int to convert

byteOrder - byte order of returned bytes (big endian if null)

dest - array in which to store returned bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if dest is null or too small or offset negative

toBytes

public static void toBytes(int[] data,
                           int dataOff,
                           int dataLen,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Write int array into byte array. Avoids creation of new byte array with each call.

Parameters:

data - int data to convert

dataOff - offset into data array

dataLen - number of ints to write

byteOrder - byte order of returned bytes (big endian if null)

dest - array in which to store returned bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if data/dest are null or bad offset values

toBytes

public static byte[] toBytes(int[] data,
                             java.nio.ByteOrder byteOrder)
                      throws EvioException

Turn int array into byte array.

Parameters:

data - int array to convert

byteOrder - byte order of returned bytes (big endian if null)

Returns:

byte array representing int array or null if data is null

Throws:

EvioException - if data array as too many elements to convert to a byte array

toBytes

public static byte[] toBytes(int[] data,
                             int offset,
                             int length,
                             java.nio.ByteOrder byteOrder)
                      throws EvioException

Turn int array into byte array.

Parameters:

data - int array to convert

offset - into int array

length - number of integers to conver to bytes

byteOrder - byte order of returned bytes (big endian if null)

Returns:

byte array representing int array or null if data is null

Throws:

EvioException - if data array has too many elements to convert to a byte array

toBytes

public static void toBytes(int[] data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn int array into byte array. Avoids creation of new byte array with each call.

Parameters:

data - int array to convert

byteOrder - byte order of written bytes (big endian if null)

dest - array in which to store written bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if data is null, dest is null or too small, or offset negative; if data array has too many elements to convert to a byte array

toBytesStream

public static byte[] toBytesStream(int[] data,
                                   java.nio.ByteOrder byteOrder)
                            throws EvioException

Turn int array into byte array. Uses IO streams to do the work - very inefficient. Keep around for tutorial purposes.

Parameters:

data - int array to convert

byteOrder - byte order of returned bytes (big endian if null)

Returns:

byte array representing int array

Throws:

EvioException - if data array has too many elements to convert to a byte array

toBytes

public static byte[] toBytes(long data,
                             java.nio.ByteOrder byteOrder)

Turn long into byte array.

Parameters:

data - long to convert

byteOrder - byte order of returned byte array (big endian if null)

Returns:

byte array representing long

toBytes

public static void toBytes(long data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn long into byte array. Avoids creation of new byte array with each call.

Parameters:

data - long to convert

byteOrder - byte order of returned bytes (big endian if null)

dest - array in which to store returned bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if dest is null or too small or offset negative

toBytes

public static byte[] toBytes(long[] data,
                             java.nio.ByteOrder byteOrder)
                      throws EvioException

Turn long array into byte array.

Parameters:

data - long array to convert

byteOrder - byte order of returned bytes (big endian if null)

Returns:

byte array representing long array or null if data is null

Throws:

EvioException - if data array has too many elements to convert to a byte array

toBytes

public static void toBytes(long[] data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn long array into byte array. Avoids creation of new byte array with each call.

Parameters:

data - long array to convert

byteOrder - byte order of written bytes (big endian if null)

dest - array in which to store written bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if data is null, dest is null or too small, or offset negative; if data array has too many elements to convert to a byte array

toBytes

public static byte[] toBytes(float data,
                             java.nio.ByteOrder byteOrder)

Turn float into byte array.

Parameters:

data - float to convert

byteOrder - byte order of returned byte array (big endian if null)

Returns:

byte array representing float

toBytes

public static void toBytes(float data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn float into byte array. Avoids creation of new byte array with each call.

Parameters:

data - float to convert

byteOrder - byte order of returned bytes (big endian if null)

dest - array in which to store returned bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if dest is null or too small or offset negative

toBytes

public static byte[] toBytes(float[] data,
                             java.nio.ByteOrder byteOrder)
                      throws EvioException

Turn float array into byte array.

Parameters:

data - float array to convert

byteOrder - byte order of returned bytes (big endian if null)

Returns:

byte array representing float array or null if data is null

Throws:

EvioException - if data array has too many elements to convert to a byte array

toBytes

public static void toBytes(float[] data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn float array into byte array. Avoids creation of new byte array with each call.

Parameters:

data - float array to convert

byteOrder - byte order of written bytes (big endian if null)

dest - array in which to store written bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if data is null, dest is null or too small, or offset negative; if data array has too many elements to convert to a byte array

toBytes

public static byte[] toBytes(double data,
                             java.nio.ByteOrder byteOrder)

Turn double into byte array.

Parameters:

data - double to convert

byteOrder - byte order of returned byte array (big endian if null)

Returns:

byte array representing double

toBytes

public static void toBytes(double data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn double into byte array. Avoids creation of new byte array with each call.

Parameters:

data - double to convert

byteOrder - byte order of returned bytes (big endian if null)

dest - array in which to store returned bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if dest is null or too small or offset negative

toBytes

public static byte[] toBytes(double[] data,
                             java.nio.ByteOrder byteOrder)
                      throws EvioException

Turn double array into byte array.

Parameters:

data - double array to convert

byteOrder - byte order of returned bytes (big endian if null)

Returns:

byte array representing double array or null if data is null

Throws:

EvioException - if data array has too many elements to convert to a byte array

toBytes

public static void toBytes(double[] data,
                           java.nio.ByteOrder byteOrder,
                           byte[] dest,
                           int off)
                    throws EvioException

Turn double array into byte array. Avoids creation of new byte array with each call.

Parameters:

data - double array to convert

byteOrder - byte order of written bytes (big endian if null)

dest - array in which to store written bytes

off - offset into dest array where returned bytes are placed

Throws:

EvioException - if data is null, dest is null or too small, or offset negative; if data array has too many elements to convert to a byte array

toShort

public static short toShort(byte[] data,
                            java.nio.ByteOrder byteOrder,
                            int off)
                     throws EvioException

Turn section of byte array into a short.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

off - offset into data array

Returns:

short converted from byte array

Throws:

EvioException - if data is null or wrong size, or off is negative

toShort

public static short toShort(byte b1,
                            byte b2,
                            java.nio.ByteOrder byteOrder)

Turn 2 bytes into a short.

Parameters:

b1 - 1st byte

b2 - 2nd byte

byteOrder - if big endian, 1st byte is most significant (big endian if null)

Returns:

short converted from byte array

toShortArray

public static short[] toShortArray(byte[] data,
                                   java.nio.ByteOrder byteOrder)
                            throws EvioException

Turn byte array into a short array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

Returns:

short array converted from byte array

Throws:

EvioException - if data is null or odd size

toShortArray

public static short[] toShortArray(byte[] data,
                                   int padding,
                                   java.nio.ByteOrder byteOrder)
                            throws EvioException

Turn byte array into a short array while taking padding into account.

Parameters:

data - byte array to convert

padding - number of bytes at the end of the byte array to ignore. Valid values are 0 and 2

byteOrder - byte order of supplied bytes (big endian if null)

Returns:

short array converted from byte array

Throws:

EvioException - if data is null or odd size; padding not 0 or 2

toShortArray

public static void toShortArray(byte[] data,
                                int padding,
                                java.nio.ByteOrder byteOrder,
                                short[] dest,
                                int off)
                         throws EvioException

Turn byte array into a short array while taking padding into account.

Parameters:

data - byte array to convert

padding - number of bytes at the end of the byte array to ignore. Valid values are 0 and 2

byteOrder - byte order of supplied bytes (big endian if null)

dest - array in which to write converted bytes

off - offset into dest array

Throws:

EvioException - if data is null or wrong size; dest is null, wrong size, or off < 0

toShortArray

public static void toShortArray(byte[] data,
                                java.nio.ByteOrder byteOrder,
                                short[] dest,
                                int off)
                         throws EvioException

Turn byte array into an short array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

dest - array in which to write converted bytes

off - offset into dest array

Throws:

EvioException - if data is null or wrong size; dest is null, wrong size, or off < 0

toInt

public static int toInt(byte[] data,
                        java.nio.ByteOrder byteOrder,
                        int off)
                 throws EvioException

Turn section of byte array into an int.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

off - offset into data array

Returns:

int converted from byte array

Throws:

EvioException - if data is null or wrong size, or off is negative

toInt

public static int toInt(byte b1,
                        byte b2,
                        byte b3,
                        byte b4,
                        java.nio.ByteOrder byteOrder)

Turn 4 bytes into an int.

Parameters:

b1 - 1st byte

b2 - 2nd byte

b3 - 3rd byte

b4 - 4th byte

byteOrder - if big endian, 1st byte is most significant & 4th is least (big endian if null)

Returns:

int converted from byte array

toIntArray

public static int[] toIntArray(byte[] data,
                               java.nio.ByteOrder byteOrder)
                        throws EvioException

Turn byte array into an int array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

Returns:

int array converted from byte array

Throws:

EvioException - if data is null or wrong size

toIntArray

public static void toIntArray(byte[] data,
                              java.nio.ByteOrder byteOrder,
                              int[] dest,
                              int off)
                       throws EvioException

Turn byte array into an int array. The data array length must be a multiple of 4. Number of int array elements = number of bytes / 4. The dest array must be large enough to contain the data.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

dest - array in which to write converted bytes

off - offset into dest array

Throws:

EvioException - if data is null or wrong size; dest is null, wrong size, or off < 0

toIntArray

public static void toIntArray(byte[] data,
                              int dataOffset,
                              java.nio.ByteOrder byteOrder,
                              int[] dest,
                              int destOffset)
                       throws EvioException

Turn byte array into an int array. Unlike the other methods, the data array length does not have to be a multiple of 4. Number of int array elements = number of bytes / 4. The dest array must be large enough to contain the data.

Parameters:

data - byte array to convert

dataOffset - offset into data array

byteOrder - byte order of supplied bytes (big endian if null)

dest - array in which to write converted bytes

destOffset - offset into dest array

Throws:

EvioException - if data is null; dest is null, wrong size, or off < 0

toIntArray

public static void toIntArray(byte[] data,
                              int dataOffset,
                              int dataLen,
                              java.nio.ByteOrder byteOrder,
                              int[] dest,
                              int destOffset)
                       throws EvioException

Turn byte array into an int array. Unlike the other methods, the data array length does not have to be a multiple of 4. Number of int array elements = number of bytes / 4. The dest array must be large enough to contain the data.

Parameters:

data - byte array to convert.

dataOffset - offset into data array.

dataLen - number of bytes to convert.

byteOrder - byte order of supplied bytes (big endian if null).

dest - array in which to write converted bytes.

destOffset - offset into dest array.

Throws:

EvioException - if data is null; dest is null, wrong size, or off < 0

toLong

public static long toLong(byte[] data,
                          java.nio.ByteOrder byteOrder,
                          int off)
                   throws EvioException

Turn section of byte array into a long.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

off - offset into data array

Returns:

long converted from byte array

Throws:

EvioException - if data is null or wrong size, or off is negative

toLong

public static long toLong(byte b1,
                          byte b2,
                          byte b3,
                          byte b4,
                          byte b5,
                          byte b6,
                          byte b7,
                          byte b8,
                          java.nio.ByteOrder byteOrder)

Turn 8 bytes into a long.

Parameters:

b1 - 1st byte

b2 - 2nd byte

b3 - 3rd byte

b4 - 4th byte

b5 - 5th byte

b6 - 6th byte

b7 - 7th byte

b8 - 8th byte

byteOrder - if big endian, 1st byte is most significant & 8th least (big endian if null)

Returns:

long converted from byte array

toLongArray

public static long[] toLongArray(byte[] data,
                                 java.nio.ByteOrder byteOrder)
                          throws EvioException

Turn byte array into a long array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

Returns:

long array converted from byte array

Throws:

EvioException - if data is null or wrong size

toLongArray

public static void toLongArray(byte[] data,
                               java.nio.ByteOrder byteOrder,
                               long[] dest,
                               int off)
                        throws EvioException

Turn byte array into an long array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

dest - array in which to write converted bytes

off - offset into dest array

Throws:

EvioException - if data is null or wrong size; dest is null, wrong size, or off < 0

toFloat

public static float toFloat(byte[] data,
                            java.nio.ByteOrder byteOrder,
                            int off)
                     throws EvioException

Turn section of byte array into a float.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

off - offset into data array

Returns:

float converted from byte array

Throws:

EvioException - if data is null or wrong size, or off is negative

toFloat

public static float toFloat(byte b1,
                            byte b2,
                            byte b3,
                            byte b4,
                            java.nio.ByteOrder byteOrder)

Turn 4 bytes into a float.

Parameters:

b1 - 1st byte

b2 - 2nd byte

b3 - 3rd byte

b4 - 4th byte

byteOrder - if big endian, 1st byte is most significant & 4th least (big endian if null)

Returns:

float converted from byte array

toFloatArray

public static float[] toFloatArray(byte[] data,
                                   java.nio.ByteOrder byteOrder)
                            throws EvioException

Turn byte array into a float array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

Returns:

float array converted from byte array

Throws:

EvioException - if data is null or wrong size

toFloatArray

public static void toFloatArray(byte[] data,
                                java.nio.ByteOrder byteOrder,
                                float[] dest,
                                int off)
                         throws EvioException

Turn byte array into an float array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

dest - array in which to write converted bytes

off - offset into dest array

Throws:

EvioException - if data is null or wrong size; dest is null, wrong size, or off < 0

toDouble

public static double toDouble(byte[] data,
                              java.nio.ByteOrder byteOrder,
                              int off)
                       throws EvioException

Turn section of byte array into a double.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

off - offset into data array

Returns:

double converted from byte array

Throws:

EvioException - if data is null or wrong size, or off is negative

toDouble

public static double toDouble(byte b1,
                              byte b2,
                              byte b3,
                              byte b4,
                              byte b5,
                              byte b6,
                              byte b7,
                              byte b8,
                              java.nio.ByteOrder byteOrder)

Turn 8 bytes into a double.

Parameters:

b1 - 1st byte

b2 - 2nd byte

b3 - 3rd byte

b4 - 4th byte

b5 - 5th byte

b6 - 6th byte

b7 - 7th byte

b8 - 8th byte

byteOrder - if big endian, 1st byte is most significant & 8th least (big endian if null)

Returns:

double converted from byte array

toDoubleArray

public static double[] toDoubleArray(byte[] data,
                                     java.nio.ByteOrder byteOrder)
                              throws EvioException

Turn byte array into a double array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

Returns:

double array converted from byte array

Throws:

EvioException - if data is null or wrong size

toDoubleArray

public static void toDoubleArray(byte[] data,
                                 java.nio.ByteOrder byteOrder,
                                 double[] dest,
                                 int off)
                          throws EvioException

Turn byte array into an double array.

Parameters:

data - byte array to convert

byteOrder - byte order of supplied bytes (big endian if null)

dest - array in which to write converted bytes

off - offset into dest array

Throws:

EvioException - if data is null or wrong size; dest is null, wrong size, or off < 0

swapArray32

public static void swapArray32(byte[] data,
                               int dataOffset,
                               int dataLen)
                        throws EvioException

Swap byte array in place assuming bytes are 32 bit ints. Number of array elements must be multiple of 4.

Parameters:

data - byte array to convert.

dataOffset - offset into data array.

dataLen - number of bytes to convert.

Throws:

EvioException - if data is null; data offset and length are improper; dataLen is not a multiple of 4.

swapEvent

public static void swapEvent(java.nio.ByteBuffer srcBuffer,
                             java.nio.ByteBuffer destBuffer,
                             int srcPos,
                             int destPos)
                      throws EvioException

This method swaps the byte order of an entire evio event or bank. The byte order of the swapped buffer will be opposite to the byte order of the the source buffer argument. If the swap is done in place, the byte order of the source buffer will be switched upon completion and the destPos arg will be set equal to the srcPos arg. The positions of the source and destination buffers are not changed. A ByteBuffer's current byte order can be found by calling ByteBuffer.order().

The data to be swapped must not be in the evio file format (with block headers). Data must only consist of bytes representing a single event/bank. Position and limit of neither buffer is changed.

Parameters:

srcBuffer - buffer containing event to swap.

destBuffer - buffer in which to placed the swapped event. If null, or identical to srcBuffer, the data is swapped in place.

srcPos - position in srcBuffer to start reading event

destPos - position in destBuffer to start writing swapped event

Throws:

EvioException - if srcBuffer arg is null; if any buffer position is not zero

swapEvent

public static void swapEvent(java.nio.ByteBuffer srcBuffer,
                             java.nio.ByteBuffer destBuffer,
                             int srcPos,
                             int destPos,
                             java.util.List<EvioNode> nodeList)
                      throws EvioException

This method swaps the byte order of an entire evio event or bank. The byte order of the swapped buffer will be opposite to the byte order of the the source buffer argument. If the swap is done in place, the byte order of the source buffer will be switched upon completion and the destPos arg will be set equal to the srcPos arg. The positions of the source and destination buffers are not changed. A ByteBuffer's current byte order can be found by calling ByteBuffer.order().

The data to be swapped must not be in the evio file format (with block headers). Data must only consist of bytes representing a single event/bank. Position and limit of neither buffer is changed.

Parameters:

srcBuffer - buffer containing event to swap.

destBuffer - buffer in which to placed the swapped event. If null, or identical to srcBuffer, the data is swapped in place.

srcPos - position in srcBuffer to start reading event

destPos - position in destBuffer to start writing swapped event

nodeList - if not null, generate and store node objects here - one for each swapped evio structure in destBuffer.

Throws:

EvioException - if srcBuffer arg is null; if any buffer position is not zero

swapEvent

public static void swapEvent(java.nio.ByteBuffer srcBuffer,
                             java.nio.ByteBuffer destBuffer,
                             int srcPos,
                             int destPos,
                             boolean swapData,
                             java.util.List<EvioNode> nodeList)
                      throws EvioException

This method swaps the byte order of an entire evio event or bank. The byte order of the swapped buffer will be opposite to the byte order of the the source buffer argument. If the swap is done in place, the byte order of the source buffer will be switched upon completion and the destPos arg will be set equal to the srcPos arg. The positions of the source and destination buffers are not changed. A ByteBuffer's current byte order can be found by calling ByteBuffer.order().

The data to be swapped must not be in the evio file format (with block headers). Data must only consist of bytes representing a single event/bank. Position and limit of neither buffer is changed.

Parameters:

srcBuffer - buffer containing event to swap.

destBuffer - buffer in which to placed the swapped event. If null, or identical to srcBuffer, the data is swapped in place.

srcPos - position in srcBuffer to start reading event

destPos - position in destBuffer to start writing swapped event

swapData - if false, do NOT swap data, else swap data too

nodeList - if not null, generate and store node objects here - one for each swapped evio structure in destBuffer.

Throws:

EvioException - if srcBuffer arg is null; if any buffer position is not zero

swapBankHeader

static void swapBankHeader(EvioNode node,
                           java.nio.ByteBuffer srcBuffer,
                           java.nio.ByteBuffer destBuffer,
                           int srcPos,
                           int destPos)
                    throws EvioException

This method reads and swaps an evio bank header. It can also return information about the bank. Position and limit of neither buffer argument is changed.

This only swaps data if buffer arguments have opposite byte order!

Parameters:

node - object in which to store data about the bank in destBuffer after swap; may be null

srcBuffer - buffer containing bank header to be swapped

destBuffer - buffer in which to place swapped bank header

srcPos - position in srcBuffer to start reading bank header

destPos - position in destBuffer to start writing swapped bank header

Throws:

EvioException - if srcBuffer too little data; if destBuffer is too small to contain swapped data

swapSegmentHeader

static void swapSegmentHeader(EvioNode node,
                              java.nio.ByteBuffer srcBuffer,
                              java.nio.ByteBuffer destBuffer,
                              int srcPos,
                              int destPos)
                       throws EvioException

This method reads and swaps an evio segment header. It can also return information about the segment. Position and limit of neither buffer argument is changed.

This only swaps data if buffer arguments have opposite byte order!

Parameters:

node - object in which to store data about the segment in destBuffer after swap; may be null

srcBuffer - buffer containing segment header to be swapped

destBuffer - buffer in which to place swapped segment header

srcPos - position in srcBuffer to start reading segment header

destPos - position in destBuffer to start writing swapped segment header

Throws:

EvioException - if srcBuffer too little data; if destBuffer is too small to contain swapped data

swapTagSegmentHeader

static void swapTagSegmentHeader(EvioNode node,
                                 java.nio.ByteBuffer srcBuffer,
                                 java.nio.ByteBuffer destBuffer,
                                 int srcPos,
                                 int destPos)
                          throws EvioException

This method reads and swaps an evio tagsegment header. It can also return information about the tagsegment. Position and limit of neither buffer argument is changed.

This only swaps data if buffer arguments have opposite byte order!

Parameters:

node - object in which to store data about the tagsegment in destBuffer after swap; may be null

srcBuffer - buffer containing tagsegment header to be swapped

destBuffer - buffer in which to place swapped tagsegment header

srcPos - position in srcBuffer to start reading tagsegment header

destPos - position in destBuffer to start writing swapped tagsegment header

Throws:

EvioException - if srcBuffer too little data; if destBuffer is too small to contain swapped data

swapData

static void swapData(DataType type,
                     java.nio.ByteBuffer srcBuffer,
                     java.nio.ByteBuffer destBuffer,
                     int srcPos,
                     int destPos,
                     int len,
                     boolean inPlace)
              throws EvioException

This method swaps the data of an evio leaf structure. In other words the structure being swapped does not contain evio structures.

Parameters:

type - type of data being swapped

srcBuffer - buffer containing data to be swapped

destBuffer - buffer in which to place swapped data

srcPos - position in srcBuffer to start reading data

destPos - position in destBuffer to start writing swapped data

len - length of data in 32 bit words

inPlace - if true, data is swapped in srcBuffer

Throws:

EvioException - if srcBuffer not in evio format; if destBuffer too small; if bad values for srcPos and/or destPos;

swapStructure

static void swapStructure(EvioNode node,
                          java.nio.ByteBuffer srcBuffer,
                          java.nio.ByteBuffer destBuffer,
                          int srcPos,
                          int destPos,
                          boolean inPlace,
                          boolean swapData,
                          java.util.List<EvioNode> nodeList)
                   throws EvioException

Swap an evio structure. If it is a structure of structures, such as a bank of banks, swap recursively.

Parameters:

node - info from parsed header

srcBuffer - buffer containing structure to swap.

destBuffer - buffer in which to place the swapped structure.

srcPos - position in srcBuffer to start reading structure

destPos - position in destBuffer to start writing swapped structure

inPlace - if true, data is swapped in srcBuffer

swapData - if false, data is NOT swapped, else it is

nodeList - if not null, store all node objects here - one for each swapped evio structure in destBuffer.

Throws:

EvioException - if srcBuffer not in evio format; if destBuffer too small; if bad values for srcPos and/or destPos;