org.rcsb.mmtf.encoder

Class WriterUtils

java.lang.Object

org.rcsb.mmtf.encoder.WriterUtils

public class WriterUtils
extends java.lang.Object

A class of static utility methods to aid writing of data.

Author:

Anthony Bradley

Constructor Summary

Constructors

Constructor and Description
WriterUtils()

Method Summary

Modifier and Type	Method and Description
static byte[]	getDataAsByteArr(AdapterToStructureData writerToEncoder) Function to take data from a writer and return as a byte array (MessagePacked serialized).
static byte[]	gzipCompress(byte[] byteArray) Compress a byte array using Gzip.
static void	writeDataToFile(AdapterToStructureData writerToEncoder, java.nio.file.Path path) Function to write data to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriterUtils

public WriterUtils()

Method Detail

writeDataToFile

public static void writeDataToFile(AdapterToStructureData writerToEncoder,
                                   java.nio.file.Path path)
                            throws java.io.IOException

Function to write data to a file.

Parameters:

writerToEncoder - the writer to encoder instance

path - the full path to write to

Throws:

java.io.IOException - an error related to byte array transfers

getDataAsByteArr

public static byte[] getDataAsByteArr(AdapterToStructureData writerToEncoder)
                               throws java.io.IOException

Function to take data from a writer and return as a byte array (MessagePacked serialized).

Parameters:

writerToEncoder - the writer to encoder instance

Returns:

a byte array of the data

Throws:

java.io.IOException - an error related to byte array transfers

gzipCompress

public static byte[] gzipCompress(byte[] byteArray)
                           throws java.io.IOException

Compress a byte array using Gzip.

Parameters:

byteArray - the input byte array

Returns:

the compressed byte array

Throws:

java.io.IOException - an exception creating the GZIP stream