Package org.nuxeo.ecm.core.io.impl.plugins

Class NuxeoArchiveWriter

java.lang.Object

org.nuxeo.ecm.core.io.impl.AbstractDocumentWriter

org.nuxeo.ecm.core.io.impl.plugins.NuxeoArchiveWriter

All Implemented Interfaces:

DocumentWriter

public class NuxeoArchiveWriter
extends AbstractDocumentWriter

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ENABLE_EXTRA_FILES_COUNT_KEY	Deprecated. since 2023.3, not used anymore
protected ZipOutputStream	out

Constructor Summary

Constructors

Constructor	Description
NuxeoArchiveWriter(File destination)
NuxeoArchiveWriter(File destination, int compressionLevel)
NuxeoArchiveWriter(OutputStream out)
NuxeoArchiveWriter(OutputStream out, int compressionLevel)
NuxeoArchiveWriter(ZipOutputStream out)
NuxeoArchiveWriter(ZipOutputStream out, int compressionLevel)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the writer.
void	setComment(String comment)
DocumentTranslationMap	write(ExportedDocument doc)	Writes a single document.
protected void	writeDocument(String path, ExportedDocument doc)
protected void	writeMarker()
protected static void	writeXML(org.dom4j.Document doc, OutputStream out)

Methods inherited from class org.nuxeo.ecm.core.io.impl.AbstractDocumentWriter

createCompactFormat, createPrettyPrint, write, write

Methods inherited from class java.lang.Object

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

Field Detail

ENABLE_EXTRA_FILES_COUNT_KEY

@Deprecated(since="2023.3")
protected static final String ENABLE_EXTRA_FILES_COUNT_KEY

Deprecated.

since 2023.3, not used anymore

Since:

2021.13

See Also:

Constant Field Values

out

protected ZipOutputStream out

Constructor Detail

NuxeoArchiveWriter

public NuxeoArchiveWriter(File destination)
                   throws IOException

Throws:

IOException

NuxeoArchiveWriter

public NuxeoArchiveWriter(File destination,
                          int compressionLevel)
                   throws IOException

Throws:

IOException

NuxeoArchiveWriter

public NuxeoArchiveWriter(OutputStream out)
                   throws IOException

Throws:

IOException

NuxeoArchiveWriter

public NuxeoArchiveWriter(OutputStream out,
                          int compressionLevel)
                   throws IOException

Throws:

IOException

NuxeoArchiveWriter

public NuxeoArchiveWriter(ZipOutputStream out)
                   throws IOException

Throws:

IOException

NuxeoArchiveWriter

public NuxeoArchiveWriter(ZipOutputStream out,
                          int compressionLevel)
                   throws IOException

Throws:

IOException

Method Detail

setComment

public void setComment(String comment)

write

public DocumentTranslationMap write(ExportedDocument doc)
                             throws IOException

Description copied from interface: DocumentWriter

Writes a single document.

Specified by:

write in interface DocumentWriter

Specified by:

write in class AbstractDocumentWriter

Parameters:

doc - the document to write

Returns:

the translation map.

Throws:

IOException

close

public void close()

Description copied from interface: DocumentWriter

Closes the writer.

writeDocument

protected void writeDocument(String path,
                             ExportedDocument doc)
                      throws IOException

Throws:

IOException

writeXML

protected static void writeXML(org.dom4j.Document doc,
                               OutputStream out)
                        throws IOException

Throws:

IOException

writeMarker

protected void writeMarker()
                    throws IOException

Throws:

IOException