ds.granules.util

Class MarshallingUtil

java.lang.Object

ds.granules.util.MarshallingUtil

public class MarshallingUtil
extends java.lang.Object

This is a utility class which includes methods for marshalling and un-marshalling several commonly used data types.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Constructor and Description
MarshallingUtil()

Method Summary

Modifier and Type	Method and Description
long[]	convertByteArrayToLongArray(byte[] sequenceOfBytes) Converts a byte[] into a long[]
byte[]	convertLongArrayToByteArray(long[] sequenceOfLongs) Converts a long[] into a byte[].
static MarshallingUtil	getInstance() Deprecated.
int	getInt(byte[] data, int offset) Given a sequence of bytes, this method returns the int value associated with the sequence of bytes.
java.util.Properties	readProperties(java.io.DataInputStream din) Reads a property object from the underlying DataInputStream
java.lang.String	readString(java.io.DataInputStream din) Reads a String from the underlying DataInputStream
void	writeProperties(java.io.DataOutputStream dout, java.util.Properties properties) Writes a java.util.Properties object to the underlying DataOutputStream
void	writeString(java.io.DataOutputStream dout, java.lang.String element) Writes a String to the underlying DataOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

MarshallingUtil

public MarshallingUtil()

Method Detail

getInstance

@Deprecated
public static MarshallingUtil getInstance()

Deprecated.

Retrieve the singleton instance of the MarshallingUtil

Returns:

The singleton instance.

convertByteArrayToLongArray

public long[] convertByteArrayToLongArray(byte[] sequenceOfBytes)
                                   throws java.io.IOException

Converts a byte[] into a long[]

Parameters:

sequenceOfBytes - The byte[] input

Returns:

The long[] representation of the byte[]

Throws:

java.io.IOException - If there are problems in the conversion process.

convertLongArrayToByteArray

public byte[] convertLongArrayToByteArray(long[] sequenceOfLongs)
                                   throws java.io.IOException

Converts a long[] into a byte[].

Parameters:

sequenceOfLongs - The long[] input

Returns:

The byte[] representation of the long[].

Throws:

java.io.IOException - If there are problems in the conversion process.

writeProperties

public void writeProperties(java.io.DataOutputStream dout,
                            java.util.Properties properties)
                     throws java.io.IOException

Writes a java.util.Properties object to the underlying DataOutputStream

Parameters:

dout - The instance of the DataOutputStream

properties - The Properties instance that needs to be serialized.

Throws:

java.io.IOException - If there are problems in the marshalling process.

readProperties

public java.util.Properties readProperties(java.io.DataInputStream din)
                                    throws java.io.IOException

Reads a property object from the underlying DataInputStream

Parameters:

din - The instance of the DataInputStream where the Properties instance will be read from.

Returns:

The underlying Properties instance

Throws:

java.io.IOException - If there are problems in the unmarshalling process.

writeString

public void writeString(java.io.DataOutputStream dout,
                        java.lang.String element)
                 throws java.io.IOException

Writes a String to the underlying DataOutputStream

Parameters:

dout - The instance of the DataOutputStream

element - The String that needs to be written

Throws:

java.io.IOException - If there are problems in the Marshalling process.

readString

public java.lang.String readString(java.io.DataInputStream din)
                            throws java.io.IOException

Reads a String from the underlying DataInputStream

Parameters:

din - The instance of the DataInputStream where the String will be read from.

Returns:

The underlying String instance

Throws:

java.io.IOException - If there are problems in the un-marshalling process.

getInt

public int getInt(byte[] data,
                  int offset)

Given a sequence of bytes, this method returns the int value associated with the sequence of bytes. This length sequence of bytes passed as the argument should satisfy the condition (data.length - offset) >= 4; otherwise, an illegal Argument exception will be thrown.

Parameters:

data - The byte[] which would be used to reconstruct the bytes

offset - The point from which an attempt to reconstruct the integer must be made

Returns:

The int value associated with the byte[] starting at the specified offset.