net.sf.oqt.core

Class Serializer

java.lang.Object

net.sf.oqt.core.Serializer

public final class Serializer
extends Object

The class centralizes the serialization process of the ResultVO.

In order to transfer the information from the plugin to the reporting plugin, the data is serialized to disk. This also allows developers to deserialize the object and use the information in other plugins.

Author:

phillip

Constructor Summary

Constructors

Constructor and Description
Serializer(org.apache.maven.project.MavenProject project) Creates a new Serializer object.

Method Summary

Methods

Modifier and Type	Method and Description
ResultVO	deserialize() Deserialized the ResultVO from disk (the location is determined in the constructor).
void	serialize(ResultVO result) Serialized the ResultVO to disk (the location is determined in the constructor).
void	textOutput(String fileName, String stringOutput)

Methods inherited from class java.lang.Object

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

Constructor Detail

Serializer

public Serializer(org.apache.maven.project.MavenProject project)
           throws IOException

Creates a new Serializer object. This will initialize the file where the ResultVO will be stored.

The directory where the object will be saved will also be created.

Parameters:

project - a reference to the Maven project.

Throws:

IOException - if failed to create the output directory

Method Detail

serialize

public void serialize(ResultVO result)
               throws IOException

Serialized the ResultVO to disk (the location is determined in the constructor).

Parameters:

result - the ResultVO to serialize.

Throws:

IOException - if failed to serialize.

deserialize

public ResultVO deserialize()
                     throws IOException,
                            ClassNotFoundException

Deserialized the ResultVO from disk (the location is determined in the constructor).

Returns:

the deserialized ResultVO or null if the file doesn't exist.

Throws:

IOException - if failed to deserialize.

ClassNotFoundException - if the ResultVO is not found on the classpath (should never occur).

textOutput

public void textOutput(String fileName,
              String stringOutput)
                throws IOException

Throws:

IOException