aterm.pure.binary

Class BinaryReader

java.lang.Object

aterm.pure.binary.BinaryReader

public class BinaryReader
extends Object

Reconstructs an ATerm from the given (series of) buffer(s). It can be retrieved when the construction of the term is done / when isDone() returns true.

For example (yes I know this code is crappy, but it's simple):

 ByteBuffer buffer = ByteBuffer.allocate(8192);
 BinaryWriter bw = new BinaryWriter(aterm);
 while(!bw.isDone()) {
   int bytesRead = channel.read(buffer); // Read the next chunk of data from the stream.
   if(!buffer.hasRemaining() || bytesRead == -1) {
     bw.serialize(buffer);
     buffer.clear();
   }
 }
 

Author:

Arnold Lankamp

Constructor Summary

Constructors

Constructor and Description
BinaryReader(PureFactory factory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	deserialize(ByteBuffer buffer) Constructs (a part of) the ATerm from the binary representation present in the given buffer.
ATerm	getRoot() Returns the reconstructed ATerm.
boolean	isDone() Checks if we are done serializing.
static ATerm	readTermFromSAFFile(PureFactory pureFactory, File file) Reads the ATerm from the given SAF encoded file.
static ATerm	readTermFromSAFString(PureFactory pureFactory, byte[] data) Reads the ATerm from the given SAF encoded data.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryReader

public BinaryReader(PureFactory factory)

Constructor.

Parameters:

factory - The factory to use for reconstruction of the ATerm.

Method Detail

deserialize

public void deserialize(ByteBuffer buffer)

Constructs (a part of) the ATerm from the binary representation present in the given buffer. This method will 'remember' where it was left.

Parameters:

buffer - The buffer that contains (a part of) the binary representation of the ATerm.

isDone

public boolean isDone()

Checks if we are done serializing.

Returns:

True if we are done; false otherwise.

getRoot

public ATerm getRoot()

Returns the reconstructed ATerm. A RuntimeException will be thrown when we are not yet done with the reconstruction of the ATerm.

Returns:

The reconstructed ATerm.

readTermFromSAFFile

public static ATerm readTermFromSAFFile(PureFactory pureFactory,
                        File file)
                                 throws IOException

Reads the ATerm from the given SAF encoded file.

Parameters:

pureFactory - The factory to use.

file - The file that contains the SAF encoded term.

Returns:

The constructed ATerm.

Throws:

IOException - Thrown when an error occurs while reading the given file.

readTermFromSAFString

public static ATerm readTermFromSAFString(PureFactory pureFactory,
                          byte[] data)

Reads the ATerm from the given SAF encoded data.

Parameters:

pureFactory - The factory to use.

data - The SAF encoded data.

Returns:

The constructed ATerm.