com.helger.photon.exchange.bulkexport

Interface IExporter

All Known Subinterfaces:

IExporterFile

All Known Implementing Classes:

ExporterCSV, ExporterExcel, ExporterJSON, ExporterXML

public interface IExporter

Generic interface for exporting records to an OutputStream.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.state.ESuccess	exportRecords(IExportRecordProvider aProvider, OutputStream aOS) Export all provided records to an output stream.

Method Detail

exportRecords

@Nonnull
com.helger.commons.state.ESuccess exportRecords(@Nonnull
                                                          IExportRecordProvider aProvider,
                                                          @Nonnull @WillClose
                                                          OutputStream aOS)

Export all provided records to an output stream.

Parameters:

aProvider - The provider for all records. May not be null.

aOS - The output stream to write to. Will be closed automatically in any case. May not be null.

Returns:

ESuccess.SUCCESS if at lease one record was provided and saving was successful.