Class ExporterXML
java.lang.Object
com.helger.photon.exchange.bulkexport.format.ExporterXML
- All Implemented Interfaces:
IExporter,IExporterFile
Implementation of
IExporterFile for XML files- Author:
- Philip Helger
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.helger.xml.microdom.IMicroDocumentconvertRecords(IExportRecordProvider aProvider) com.helger.commons.state.ESuccessexportRecords(IExportRecordProvider aProvider, OutputStream aOS) Export all provided records to an output stream.final Charsetfinal EExchangeFileTypefinal com.helger.xml.serialize.write.IXMLWriterSettingsfinal booleanfinal ExporterXMLsetCharset(Charset aCharset) final ExporterXMLsetEmitTypeAttr(boolean bEmitTypeAttr) final com.helger.xml.serialize.write.XMLWriterSettings
-
Field Details
-
DEFAULT_EMIT_TYPE_ATTRIBUTE
public static final boolean DEFAULT_EMIT_TYPE_ATTRIBUTE- See Also:
-
ELEMENT_ROOT
- See Also:
-
ELEMENT_HEADER
- See Also:
-
ELEMENT_BODY
- See Also:
-
ELEMENT_FOOTER
- See Also:
-
ELEMENT_RECORD
- See Also:
-
ELEMENT_FIELD
- See Also:
-
ATTR_TYPE
- See Also:
-
-
Constructor Details
-
ExporterXML
public ExporterXML()
-
-
Method Details
-
getFileType
- Specified by:
getFileTypein interfaceIExporterFile- Returns:
- The file type for export.
-
getCharset
-
setCharset
-
xmlWriterSettings
@Nonnull @ReturnsMutableObject public final com.helger.xml.serialize.write.XMLWriterSettings xmlWriterSettings() -
getXMLWriterSettings
@Nonnull @ReturnsImmutableObject public final com.helger.xml.serialize.write.IXMLWriterSettings getXMLWriterSettings() -
isEmitTypeAttr
public final boolean isEmitTypeAttr() -
setEmitTypeAttr
-
convertRecords
@Nullable public com.helger.xml.microdom.IMicroDocument convertRecords(@Nonnull IExportRecordProvider aProvider) -
exportRecords
@Nonnull public com.helger.commons.state.ESuccess exportRecords(@Nonnull IExportRecordProvider aProvider, @Nonnull @WillClose OutputStream aOS) Description copied from interface:IExporterExport all provided records to an output stream.- Specified by:
exportRecordsin interfaceIExporter- Parameters:
aProvider- The provider for all records. May not benull.aOS- The output stream to write to. Will be closed automatically in any case. May not benull.- Returns:
ESuccess.SUCCESSif at lease one record was provided and saving was successful.
-