unsw.cse.framescript
Interface Serialiser

All Known Implementing Classes:
MicaBotSerialiser, XMLSerialiser

public interface Serialiser

An interface that all Serialisers for FrameScript should implement.

Author:
mmcgill

Method Summary
 void serialiseTo(java.lang.String filename)
          Serialises FrameScript to a file.
 void unserialiseFrom(java.lang.String filename)
          Deserialises FrameScript from a file.
 

Method Detail

serialiseTo

void serialiseTo(java.lang.String filename)
                 throws java.io.IOException,
                        unsw.cse.framescript.SerialisationException
Serialises FrameScript to a file.

Parameters:
filename - name of the file to serialise to
Throws:
java.io.IOException - any exceptions writing to the file
unsw.cse.framescript.SerialisationException - any exceptions in serialising FrameScript

unserialiseFrom

void unserialiseFrom(java.lang.String filename)
                     throws java.io.IOException,
                            unsw.cse.framescript.SerialisationException
Deserialises FrameScript from a file.

Parameters:
filename - the name of the file to deserialise from
Throws:
java.io.IOException - any errors reading from the file
unsw.cse.framescript.SerialisationException - any errors deserialising an object