de.smartics.testdoc.core.export
Interface ExportAdapter

All Known Subinterfaces:

JmxExportAdapterMBean

All Known Implementing Classes:

AbstractExportAdapter, AbstractFileBasedExportAdapter, AbstractInMemoryExportAdapter, BasedFilerSingletonInMemoryExportAdapter, DirectoryExportAdapter, FilerExportAdapter, JmxExportAdapter, JmxExportAdapterClient, MultiExportAdapter, SingletonInMemoryExportAdapter

public interface ExportAdapter

Allows to export the information gathered by the TestDocProcessor.

For API stability implementers should choose to extend AbstractExportAdapter instead of implementing this interface directly.

Implementations of this interface are required to support a public no-args constructor.

Author:

Robert Reiner

Method Summary

void	clear(Type testCaseType) Removes documentation already exported for the given test case type.
void	export(UnitTestDoc testDoc) Exports the documentation to the implementation dependent destination.
boolean	exportQuietly(UnitTestDoc testDoc) Exports the documentation to the implementation dependent destination, suppressing any exceptions raised.

Method Detail

export

void export(UnitTestDoc testDoc)
            throws ExportException

Exports the documentation to the implementation dependent destination.

Parameters:

testDoc - the documentation to export.

Throws:

ExportException - if the export encounters some unrecoverable problem.

exportQuietly

boolean exportQuietly(UnitTestDoc testDoc)

Exports the documentation to the implementation dependent destination, suppressing any exceptions raised. Use this method if your are not interested in details why the export has failed.

Parameters:

testDoc - the documentation to export.

Returns:

true if the export has been performed successfully, false otherwise.

clear

void clear(Type testCaseType)
           throws ExportException

Removes documentation already exported for the given test case type.

Parameters:

testCaseType - the test case type whose information is to be cleared.

Throws:

ExportException - if clearing the information failed.