gov.sandia.cognition.io.serialization

Interface FileSerializationHandler<SerializedType>

Type Parameters:

SerializedType - The type of object that can be serialized.

All Known Subinterfaces:

StreamSerializationHandler<SerializedType>, TextSerializationHandler<SerializedType>

All Known Implementing Classes:

AbstractFileSerializationHandler, AbstractStreamSerializationHandler, AbstractTextSerializationHandler, GZIPSerializationHandler, JavaDefaultBinarySerializationHandler, XStreamSerializationHandler

public interface FileSerializationHandler<SerializedType>

Defines the functionality of a serialization handler that can write an object to a file and read an object from a file.

Since:

3.0

Author:

Justin Basilico

See Also:

AbstractFileSerializationHandler, StreamSerializationHandler, TextSerializationHandler

Method Summary

Modifier and Type	Method and Description
java.lang.Object	readFromFile(java.io.File file) Reads an object from the given file.
java.lang.Object	readFromFile(java.lang.String fileName) Reads an object from the given file.
void	writeToFile(java.io.File file, SerializedType object) Reads an object from a given file.
void	writeToFile(java.lang.String fileName, SerializedType object) Writes an object to a given file.

Method Detail

writeToFile

void writeToFile(java.lang.String fileName,
                 SerializedType object)
          throws java.io.IOException

Writes an object to a given file.

Parameters:

fileName - The name of the file to write the object to.

object - The object to write.

Throws:

java.io.IOException - If there is an i/o error.

writeToFile

void writeToFile(java.io.File file,
                 SerializedType object)
          throws java.io.IOException

Reads an object from a given file.

Parameters:

file - The file to write the object to.

object - The object to write.

Throws:

java.io.IOException - If there is an i/o error.

readFromFile

java.lang.Object readFromFile(java.lang.String fileName)
                       throws java.io.IOException,
                              java.lang.ClassNotFoundException

Reads an object from the given file.

Parameters:

fileName - The name of the file to read an object from.

Returns:

The object read from the file.

Throws:

java.io.IOException - If there is an i/o error.

java.lang.ClassNotFoundException - If a class cannot be found.

readFromFile

java.lang.Object readFromFile(java.io.File file)
                       throws java.io.IOException,
                              java.lang.ClassNotFoundException

Reads an object from the given file.

Parameters:

file - The file to read an object from.

Returns:

The object read from the file.

Throws:

java.io.IOException - If there is an i/o error.

java.lang.ClassNotFoundException - If a class cannot be found.