zserio.extension.common

Class OutputFileManager

java.lang.Object

zserio.extension.common.OutputFileManager

public final class OutputFileManager
extends java.lang.Object

Helper class which manages all files generated by an extension. Output file manager provides logic which decides whether it's needed to regenerate each particular file based on its timestamp.

Constructor Summary

Constructors

Constructor and Description
OutputFileManager(ExtensionParameters extensionParameters) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	checkTimestamps(java.io.File outputFile) Checks file's timestamps against timestamps of Zserio sources and resources (e.g.
java.lang.Boolean	getOutputFileInfo(java.io.File outputFile) Gets information about an output file.
void	printReport() Prints report about output files.
void	registerOutputFile(java.io.File outputFile) Registers newly generated output file.
void	registerOutputFile(java.io.File outputFile, boolean generated) Registers an output file.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputFileManager

public OutputFileManager(ExtensionParameters extensionParameters)

Constructor.

Parameters:

extensionParameters - Extension parameters.

Method Detail

printReport

public void printReport()

Prints report about output files.

checkTimestamps

public boolean checkTimestamps(java.io.File outputFile)

Checks file's timestamps against timestamps of Zserio sources and resources (e.g. jar file). When the file is newer than Zserio sources and resources, then it's up to date and its generation can be safely skipped, if any other circumstances (e.g. extension parameters) were not changed. It's the responsibility of each extension to decide whether it's safe to skip the generation.

Parameters:

outputFile - Output file to check.

Returns:

True if the output file is newer than Zserio sources and resources, False otherwise.

registerOutputFile

public void registerOutputFile(java.io.File outputFile,
                               boolean generated)
                        throws ZserioExtensionException

Registers an output file.

Parameters:

outputFile - Output file to register.

generated - True if file is newly generated, False if the file generation is skipped.

Throws:

ZserioExtensionException - if the outputFile is already registered.

registerOutputFile

public void registerOutputFile(java.io.File outputFile)
                        throws ZserioExtensionException

Registers newly generated output file. Overloaded function provided for convenience.

Parameters:

outputFile - Output file to register.

Throws:

ZserioExtensionException - if the outputFile is already registered.

getOutputFileInfo

public java.lang.Boolean getOutputFileInfo(java.io.File outputFile)

Gets information about an output file.

Parameters:

outputFile - Output file to get info for.

Returns:

True if the file is being generated, False if it has been skipped and null if it's not yet registered.