gov.sandia.cognition.io.serialization

Interface TextSerializationHandler<SerializedType>

Type Parameters:

SerializedType - The type of object that can be serialized.

All Superinterfaces:

FileSerializationHandler<SerializedType>, StreamSerializationHandler<SerializedType>

All Known Implementing Classes:

AbstractTextSerializationHandler, XStreamSerializationHandler

public interface TextSerializationHandler<SerializedType>
extends StreamSerializationHandler<SerializedType>

Interface for a serialization handler that can serialize to text. Since it can do text, it is assumed that it can also stream and write to a file.

Since:

3.0

Author:

Justin Basilico

See Also:

AbstractTextSerializationHandler, XStreamSerializationHandler

Method Summary

Modifier and Type	Method and Description
java.lang.Object	convertFromString(java.lang.String string) Converts an object from its serialized string representation.
java.lang.String	convertToString(SerializedType object) Converts a given object to its serialized string representation.
java.lang.Object	readObject(java.io.Reader reader) Reads an object from the given reader.
void	writeObject(java.io.Writer writer, SerializedType object) Writes an object to the given writer.

Methods inherited from interface gov.sandia.cognition.io.serialization.StreamSerializationHandler

convertFromBytes, convertToBytes, readObject, writeObject

Methods inherited from interface gov.sandia.cognition.io.serialization.FileSerializationHandler

readFromFile, readFromFile, writeToFile, writeToFile

Method Detail

writeObject

void writeObject(java.io.Writer writer,
                 SerializedType object)
          throws java.io.IOException

Writes an object to the given writer.

Parameters:

writer - Writer to write the object to.

object - The object to write.

Throws:

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

readObject

java.lang.Object readObject(java.io.Reader reader)
                     throws java.io.IOException,
                            java.lang.ClassNotFoundException

Reads an object from the given reader.

Parameters:

reader - The reader to read an object from.

Returns:

The object read from the reader.

Throws:

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

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

convertToString

java.lang.String convertToString(SerializedType object)
                          throws java.io.IOException

Converts a given object to its serialized string representation.

Parameters:

object - The object to serialized to a string.

Returns:

The serialized string version of the object.

Throws:

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

convertFromString

java.lang.Object convertFromString(java.lang.String string)
                            throws java.io.IOException,
                                   java.lang.ClassNotFoundException

Converts an object from its serialized string representation.

Parameters:

string - The string to convert an object from.

Returns:

The object deserialized from the string.

Throws:

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

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