org.apache.reef.tang

Interface ClassHierarchySerializer

All Known Implementing Classes:

AvroClassHierarchySerializer

@DefaultImplementation(value=AvroClassHierarchySerializer.class)
public interface ClassHierarchySerializer

A base interface for ClassHierarchy serializers.

Method Summary

Methods

Modifier and Type	Method and Description
ClassHierarchy	fromByteArray(byte[] theBytes) Deserializes a ClassHierarchy from a byte[] created with toByteArray().
ClassHierarchy	fromFile(File file) Loads a ClassHierarchy from a file created with toFile().
ClassHierarchy	fromString(String theString) Deserializes a ClassHierarchy from a String created with toString().
ClassHierarchy	fromTextFile(File file) Loads a ClassHierarchy from a text file created with toTextFile().
byte[]	toByteArray(ClassHierarchy classHierarchy) Serializes a ClassHierarchy as a byte[].
void	toFile(ClassHierarchy classHierarchy, File file) Writes a ClassHierarchy into a file.
String	toString(ClassHierarchy classHierarchy) Serializes a ClassHierarchy as a String.
void	toTextFile(ClassHierarchy classHierarchy, File file) Writes a ClassHierarchy into a text file.

Method Detail

toFile

void toFile(ClassHierarchy classHierarchy,
          File file)
            throws IOException

Writes a ClassHierarchy into a file.

Parameters:

classHierarchy - the ClassHierarchy to store

file - the file to store the ClassHierarchy

Throws:

IOException - if there is an error in the process

toTextFile

void toTextFile(ClassHierarchy classHierarchy,
              File file)
                throws IOException

Writes a ClassHierarchy into a text file.

Parameters:

classHierarchy - the ClassHierarchy to store

file - the text file to store the ClassHierarchy

Throws:

IOException - if there is an error in the process

toByteArray

byte[] toByteArray(ClassHierarchy classHierarchy)
                   throws IOException

Serializes a ClassHierarchy as a byte[].

Parameters:

classHierarchy - the ClassHierarchy to store

Returns:

the byte array containing the serialized class hierarchy

Throws:

IOException - if there is an error in the process

toString

String toString(ClassHierarchy classHierarchy)
                throws IOException

Serializes a ClassHierarchy as a String.

Parameters:

classHierarchy - the ClassHierarchy to store

Returns:

the string containing the serialized class hierarchy

Throws:

IOException - if there is an error in the process

fromFile

ClassHierarchy fromFile(File file)
                        throws IOException

Loads a ClassHierarchy from a file created with toFile().

Parameters:

file - the File to read from

Returns:

the class hierarchy

Throws:

IOException - if the File can't be read or parsed

fromTextFile

ClassHierarchy fromTextFile(File file)
                            throws IOException

Loads a ClassHierarchy from a text file created with toTextFile().

Parameters:

file - the File to read from

Returns:

the class hierarchy

Throws:

IOException - if the File can't be read or parsed

fromByteArray

ClassHierarchy fromByteArray(byte[] theBytes)
                             throws IOException

Deserializes a ClassHierarchy from a byte[] created with toByteArray().

Parameters:

theBytes - the byte[] to deserialize

Returns:

the class hierarchy

Throws:

IOException - if the byte[] can't be read or parsed

fromString

ClassHierarchy fromString(String theString)
                          throws IOException

Deserializes a ClassHierarchy from a String created with toString().

Parameters:

theString - the String to deserialize

Returns:

the class hierarchy

Throws:

IOException - if the String can't be read or parsed