com.helger.photon.exchange.bulkexport.format

Class ExporterJSON

java.lang.Object

com.helger.photon.exchange.bulkexport.format.ExporterJSON

All Implemented Interfaces:

IExporter, IExporterFile

@NotThreadSafe
public class ExporterJSON
extends Object
implements IExporterFile

Implementation of IExporterFile for JSON files

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_EMIT_TYPE

Constructor Summary

Constructors

Constructor and Description
ExporterJSON()

Method Summary

Modifier and Type	Method and Description
com.helger.json.IJsonObject	convertRecords(IExportRecordProvider aProvider)
com.helger.commons.state.ESuccess	exportRecords(IExportRecordProvider aProvider, OutputStream aOS) Export all provided records to an output stream.
Charset	getCharset()
EExchangeFileType	getFileType()
com.helger.json.serialize.IJsonWriterSettings	getJsonWriterSettings()
boolean	isEmitType()
ExporterJSON	setCharset(Charset aCharset)
ExporterJSON	setEmitType(boolean bEmitType)
ExporterJSON	setJsonWriterSettings(com.helger.json.serialize.IJsonWriterSettings aJWS)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EMIT_TYPE

public static final boolean DEFAULT_EMIT_TYPE

See Also:

Constant Field Values

Constructor Detail

ExporterJSON

public ExporterJSON()

Method Detail

getCharset

@Nonnull
public Charset getCharset()

setCharset

@Nonnull
public ExporterJSON setCharset(@Nonnull
                                         Charset aCharset)

getJsonWriterSettings

@Nonnull
public com.helger.json.serialize.IJsonWriterSettings getJsonWriterSettings()

setJsonWriterSettings

@Nonnull
public ExporterJSON setJsonWriterSettings(@Nonnull
                                                    com.helger.json.serialize.IJsonWriterSettings aJWS)

isEmitType

public boolean isEmitType()

setEmitType

@Nonnull
public ExporterJSON setEmitType(boolean bEmitType)

convertRecords

@Nullable
public com.helger.json.IJsonObject convertRecords(@Nonnull
                                                             IExportRecordProvider aProvider)

exportRecords

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

Description copied from interface: IExporter

Export all provided records to an output stream.

Specified by:

exportRecords in interface IExporter

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.

getFileType

@Nonnull
public EExchangeFileType getFileType()

Specified by:

getFileType in interface IExporterFile

Returns:

The file type for export.