Package org.springframework.ai.writer

Class FileDocumentWriter

java.lang.Object

org.springframework.ai.writer.FileDocumentWriter

All Implemented Interfaces:

Consumer<List<Document>>, DocumentWriter

public class FileDocumentWriter
extends Object
implements DocumentWriter

Writes the content of a list of Documents into a file.

Author:

Christian Tzolov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_END_PAGE_NUMBER
static final String	METADATA_START_PAGE_NUMBER

Constructor Summary

Constructors

Constructor	Description
FileDocumentWriter(String fileName)
FileDocumentWriter(String fileName, boolean withDocumentMarkers)
FileDocumentWriter(String fileName, boolean withDocumentMarkers, MetadataMode metadataMode, boolean append)	Writes the content of a list of Documents into a file.

Method Summary

Modifier and Type	Method	Description
void	accept(List<Document> docs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Field Details

METADATA_START_PAGE_NUMBER

public static final String METADATA_START_PAGE_NUMBER

See Also:

• Constant Field Values

METADATA_END_PAGE_NUMBER

public static final String METADATA_END_PAGE_NUMBER

See Also:

• Constant Field Values

Constructor Details

FileDocumentWriter

public FileDocumentWriter(String fileName)

FileDocumentWriter

public FileDocumentWriter(String fileName,
 boolean withDocumentMarkers)

FileDocumentWriter

public FileDocumentWriter(String fileName,
 boolean withDocumentMarkers,
 MetadataMode metadataMode,
 boolean append)

Writes the content of a list of Documents into a file.

Parameters:

fileName - The name of the file to write the documents to.

withDocumentMarkers - Whether to include document markers in the output.

metadataMode - Document content formatter mode. Specifies what document content to be written to the file.

append - if true, then data will be written to the end of the file rather than the beginning.

Method Details

accept

public void accept(List<Document> docs)

Specified by:

accept in interface Consumer<List<Document>>