com.groupdocs.markdown

Class ExportImagesToFileSystemStrategy

java.lang.Object

com.groupdocs.markdown.ExportImagesToFileSystemStrategy

All Implemented Interfaces:

IImageExportStrategy

public class ExportImagesToFileSystemStrategy
extends Object
implements IImageExportStrategy

Implements an image export strategy that saves images to the file system during document conversion.

This strategy saves all images from the source document to a specified folder on the file system. The images are saved with their original filenames as provided by the ImageExportContext. If the specified images folder does not exist, it will be created automatically.

Example:

 MarkdownConversionOptions options = new MarkdownConversionOptions();
 options.setImageExportStrategy(new ExportImagesToFileSystemStrategy("output/images"));

 // Convert document and save images to the specified folder
 String markdown = MarkdownConverter.convert("document.docx", options);
 // Images will be saved to the "output/images" folder
 // and referenced in the markdown as ![](images/img-001.png)
 

Constructor Summary

Constructors

Constructor and Description
ExportImagesToFileSystemStrategy(String imagesFolder) Initializes a new instance of the ExportImagesToFileSystemStrategy class.
ExportImagesToFileSystemStrategy(String imagesFolder, String markdownImagesFolder) Initializes a new instance of the ExportImagesToFileSystemStrategy class.

Method Summary

Modifier and Type	Method and Description
String	getImagesFolder() Gets the folder where images will be exported.
OutputStream	getImageStream(ImageExportContext context) Gets a stream for writing the exported image to the file system.
String	getMarkdownImagesFolder() Gets the image path for the Markdown file

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportImagesToFileSystemStrategy

public ExportImagesToFileSystemStrategy(String imagesFolder)

Initializes a new instance of the ExportImagesToFileSystemStrategy class.

Parameters:

imagesFolder - The folder where images will be exported.

Throws:

IllegalArgumentException - if imagesFolder is null or empty.

ExportImagesToFileSystemStrategy

public ExportImagesToFileSystemStrategy(String imagesFolder,
                                        String markdownImagesFolder)

Initializes a new instance of the ExportImagesToFileSystemStrategy class.

Parameters:

imagesFolder - The folder where images will be exported.

markdownImagesFolder - The image folder for markdown image urls.

Throws:

IllegalArgumentException - if imagesFolder is null or empty.

Method Detail

getImagesFolder

public String getImagesFolder()

Gets the folder where images will be exported.

Specified by:

getImagesFolder in interface IImageExportStrategy

Returns:

The path to the folder where images will be saved.

getImageStream

public OutputStream getImageStream(ImageExportContext context)
                            throws IOException

Gets a stream for writing the exported image to the file system.

Specified by:

getImageStream in interface IImageExportStrategy

Parameters:

context - The image export context containing information about the image being processed.

Returns:

A stream for writing the image data to the file system.

Throws:

IOException - if the file cannot be created or opened for writing.

If the images folder does not exist, it will be created automatically. The image will be saved with the filename specified in the context.

getMarkdownImagesFolder

public String getMarkdownImagesFolder()

Gets the image path for the Markdown file