aterm.pure.binary

Class BinaryWriter

java.lang.Object

aterm.ATermFwdVoid

aterm.pure.binary.BinaryWriter

All Implemented Interfaces:

jjtraveler.Visitor

public class BinaryWriter
extends ATermFwdVoid

Writes the given ATerm to a (streamable) binary format. Supply the constructor of this class with a ATerm and keep calling the serialize method until the finished() method 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.isFinished()) {
   buffer.clear();
   bw.serialize(buffer);
   while(buffer.hasRemaining()) channel.write(buffer); // Write the chunk of data to a channel
 }
 

Author:

Arnold Lankamp

Constructor Summary

Constructors

Constructor and Description
BinaryWriter(ATerm root) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isFinished() Checks if we are done serializing.
void	serialize(ByteBuffer buffer) Serializes the term from the position where it left of the last time this method was called.
void	voidVisitAppl(ATermAppl arg) Serializes the given appl.
void	voidVisitBlob(ATermBlob arg) Serializes the given blob.
void	voidVisitInt(ATermInt arg) Serializes the given int.
void	voidVisitList(ATermList arg) Serializes the given list.
void	voidVisitLong(ATermLong arg) Serializes the given long.
void	voidVisitPlaceholder(ATermPlaceholder arg) Serializes the given placeholder.
void	voidVisitReal(ATermReal arg) Serializes the given real.
static void	writeTermToSAFFile(ATerm aTerm, File file) Writes the given aterm to the given file.
static byte[]	writeTermToSAFString(ATerm aTerm) Writes the given aterm to a byte array.

Methods inherited from class aterm.ATermFwdVoid

visit, visitAFun, visitAppl, visitATerm, visitBlob, visitInt, visitList, visitLong, visitPlaceholder, visitReal, voidVisitATerm

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryWriter

public BinaryWriter(ATerm root)

Constructor.

Parameters:

root - The ATerm that needs to be serialized.

Method Detail

serialize

public void serialize(ByteBuffer buffer)
               throws jjtraveler.VisitFailure

Serializes the term from the position where it left of the last time this method was called. Note that the buffer will be flipped before returned.

Parameters:

buffer - The buffer that will be filled with data.

Throws:

jjtraveler.VisitFailure - Never thrown.

isFinished

public boolean isFinished()

Checks if we are done serializing.

Returns:

true when we are done serializing; false otherwise.

voidVisitAppl

public void voidVisitAppl(ATermAppl arg)
                   throws jjtraveler.VisitFailure

Serializes the given appl. The function name of the appl can be serialized in chunks.

Overrides:

voidVisitAppl in class ATermFwdVoid

Throws:

jjtraveler.VisitFailure - Never thrown.

See Also:

ATermFwdVoid.voidVisitAppl(ATermAppl)

voidVisitBlob

public void voidVisitBlob(ATermBlob arg)
                   throws jjtraveler.VisitFailure

Serializes the given blob. A blob can be serialized in chunks.

Overrides:

voidVisitBlob in class ATermFwdVoid

Throws:

jjtraveler.VisitFailure - Never thrown.

See Also:

ATermFwdVoid.voidVisitBlob(ATermBlob)

voidVisitInt

public void voidVisitInt(ATermInt arg)
                  throws jjtraveler.VisitFailure

Serializes the given int. Ints will always be serialized in one piece.

Overrides:

voidVisitInt in class ATermFwdVoid

Throws:

jjtraveler.VisitFailure - Never thrown.

See Also:

ATermFwdVoid.voidVisitInt(ATermInt)

voidVisitLong

public void voidVisitLong(ATermLong arg)
                   throws jjtraveler.VisitFailure

Serializes the given long.

Overrides:

voidVisitLong in class ATermFwdVoid

Throws:

jjtraveler.VisitFailure - Never thrown.

See Also:

ATermFwdVoid.voidVisitLong(ATermLong)

voidVisitList

public void voidVisitList(ATermList arg)
                   throws jjtraveler.VisitFailure

Serializes the given list. List information will always be serialized in one piece.

Overrides:

voidVisitList in class ATermFwdVoid

Throws:

jjtraveler.VisitFailure - Never thrown.

See Also:

ATermFwdVoid.voidVisitList(ATermList)

voidVisitPlaceholder

public void voidVisitPlaceholder(ATermPlaceholder arg)
                          throws jjtraveler.VisitFailure

Serializes the given placeholder. Placeholders will always be serialized in one piece.

Overrides:

voidVisitPlaceholder in class ATermFwdVoid

Throws:

jjtraveler.VisitFailure - Never thrown.

See Also:

ATermFwdVoid.voidVisitPlaceholder(ATermPlaceholder)

voidVisitReal

public void voidVisitReal(ATermReal arg)
                   throws jjtraveler.VisitFailure

Serializes the given real. Reals will always be serialized in one peice.

Overrides:

voidVisitReal in class ATermFwdVoid

Throws:

jjtraveler.VisitFailure - Never thrown.

See Also:

ATermFwdVoid.voidVisitReal(ATermReal)

writeTermToSAFFile

public static void writeTermToSAFFile(ATerm aTerm,
                      File file)
                               throws IOException,
                                      jjtraveler.VisitFailure

Writes the given aterm to the given file. Blocks of 65536 bytes will be used.

Parameters:

aTerm - The ATerm that needs to be writen to file.

file - The file to write to.

Throws:

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

jjtraveler.VisitFailure - This never happens

writeTermToSAFString

public static byte[] writeTermToSAFString(ATerm aTerm)
                                   throws jjtraveler.VisitFailure

Writes the given aterm to a byte array. The reason this method returns a byte array instead of a Java String is because otherwise the binary data would be corrupted, since it would be automatically encoded in UTF-16 format (which would completely mess everything up). Blocks of 65536 bytes will be used.

Parameters:

aTerm - The ATerm that needs to be written to a byte array.

Returns:

The serialized representation of the given ATerm contained in a byte array.

Throws:

jjtraveler.VisitFailure - This never happens