XMLDirectoryWriter (Nuxeo 2021.53.3 API Documentation)

java.lang.Object
- org.nuxeo.ecm.core.io.impl.AbstractDocumentWriter
- - org.nuxeo.ecm.core.io.impl.plugins.XMLDirectoryWriter

All Implemented Interfaces:

DocumentWriter
```
public class XMLDirectoryWriter
extends AbstractDocumentWriter
```
This class plays a role in the export pipe.It is used to generate xml files that have a nuxeo specific format.Each file contains information about a document model such as,general information like name, uid or document type, and information about the schemas that the document includes.

Author:

btatar

Field Summary

Fields
Modifier and Type Field Description

protected boolean skipBlobs
Allow to skip the blob from export : useful in case of a Nuxeo 2 Nuxeo migration

Constructor Summary

Constructors
Constructor Description

XMLDirectoryWriter(File destination)

XMLDirectoryWriter(String destinationPath)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Closes the writer.
`Object`	`getDestination()`	Gives the destination where the XML file will be generated.
`void`	`setDestination(File destination)`	Sets the destination where the XML file will be generated.
`void`	`setSkipBlobs(boolean skipBlobs)`
`boolean`	`skipBlobs()`
`DocumentTranslationMap`	`write(ExportedDocument doc)`	Writes a single document.

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
  - skipBlobs
```
protected boolean skipBlobs
```
    Allow to skip the blob from export : useful in case of a Nuxeo 2 Nuxeo migration
    
    Since:
    
    7.4
- Constructor Detail
  - XMLDirectoryWriter
```
public XMLDirectoryWriter(String destinationPath)
```
  - XMLDirectoryWriter
```
public XMLDirectoryWriter(File destination)
```
- Method Detail
  - skipBlobs
```
public boolean skipBlobs()
```
    Since:
    
    7.4
  - setSkipBlobs
```
public void setSkipBlobs(boolean skipBlobs)
```
    Since:
    
    7.4
  - getDestination
```
public Object getDestination()
```
    Gives the destination where the XML file will be generated.
  - setDestination
```
public void setDestination(File destination)
```
    Sets the destination where the XML file will be generated.
  - close
```
public void close()
```
    Description copied from interface: DocumentWriter
    
    Closes the writer.
  - 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