org.apache.reef.tang.implementation.avro

Class AvroClassHierarchySerializer

java.lang.Object

org.apache.reef.tang.implementation.avro.AvroClassHierarchySerializer

All Implemented Interfaces:

ClassHierarchySerializer

public final class AvroClassHierarchySerializer
extends Object
implements ClassHierarchySerializer

Serialize and Deserialize ClassHierarchy to and from AvroClassHierarchy. This class is stateless and is therefore safe to reuse.

Constructor Summary

Constructors

Constructor and Description
AvroClassHierarchySerializer()

Method Summary

Methods

Modifier and Type	Method and Description
ClassHierarchy	fromAvro(AvroNode n) Deserialize the ClassHierarchy from the AvroNode.
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().
AvroNode	toAvro(ClassHierarchy ch) Serialize the ClassHierarchy into the AvroNode.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvroClassHierarchySerializer

@Inject
public AvroClassHierarchySerializer()

Method Detail

toAvro

public AvroNode toAvro(ClassHierarchy ch)

Serialize the ClassHierarchy into the AvroNode.

Parameters:

ch - ClassHierarchy to serialize

Returns:

a Avro node having class hierarchy

fromAvro

public ClassHierarchy fromAvro(AvroNode n)

Deserialize the ClassHierarchy from the AvroNode.

Parameters:

n - AvroNode to deserialize

Returns:

a class hierarchy

toFile

public void toFile(ClassHierarchy classHierarchy,
          File file)
            throws IOException

Description copied from interface: ClassHierarchySerializer

Writes a ClassHierarchy into a file.

Specified by:

toFile in interface ClassHierarchySerializer

Parameters:

classHierarchy - the ClassHierarchy to store

file - the file to store the ClassHierarchy

Throws:

IOException - if there is an error in the process

toByteArray

public byte[] toByteArray(ClassHierarchy classHierarchy)
                   throws IOException

Description copied from interface: ClassHierarchySerializer

Serializes a ClassHierarchy as a byte[].

Specified by:

toByteArray in interface ClassHierarchySerializer

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

public String toString(ClassHierarchy classHierarchy)
                throws IOException

Description copied from interface: ClassHierarchySerializer

Serializes a ClassHierarchy as a String.

Specified by:

toString in interface ClassHierarchySerializer

Parameters:

classHierarchy - the ClassHierarchy to store

Returns:

the string containing the serialized class hierarchy

Throws:

IOException - if there is an error in the process

toTextFile

public void toTextFile(ClassHierarchy classHierarchy,
              File file)
                throws IOException

Description copied from interface: ClassHierarchySerializer

Writes a ClassHierarchy into a text file.

Specified by:

toTextFile in interface ClassHierarchySerializer

Parameters:

classHierarchy - the ClassHierarchy to store

file - the text file to store the ClassHierarchy

Throws:

IOException - if there is an error in the process

fromFile

public ClassHierarchy fromFile(File file)
                        throws IOException

Description copied from interface: ClassHierarchySerializer

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

Specified by:

fromFile in interface ClassHierarchySerializer

Parameters:

file - the File to read from

Returns:

the class hierarchy

Throws:

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

fromByteArray

public ClassHierarchy fromByteArray(byte[] theBytes)
                             throws IOException

Description copied from interface: ClassHierarchySerializer

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

Specified by:

fromByteArray in interface ClassHierarchySerializer

Parameters:

theBytes - the byte[] to deserialize

Returns:

the class hierarchy

Throws:

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

fromString

public ClassHierarchy fromString(String theString)
                          throws IOException

Description copied from interface: ClassHierarchySerializer

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

Specified by:

fromString in interface ClassHierarchySerializer

Parameters:

theString - the String to deserialize

Returns:

the class hierarchy

Throws:

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

fromTextFile

public ClassHierarchy fromTextFile(File file)
                            throws IOException

Description copied from interface: ClassHierarchySerializer

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

Specified by:

fromTextFile in interface ClassHierarchySerializer

Parameters:

file - the File to read from

Returns:

the class hierarchy

Throws:

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