com.groupdocs.markdown

Class MarkdownConverter

java.lang.Object

com.groupdocs.markdown.MarkdownConverter

All Implemented Interfaces:

AutoCloseable

public class MarkdownConverter
extends Object
implements AutoCloseable

Converts various document formats to Markdown format. Java-idiomatic port of the original C# MarkdownConverter.

Constructor Summary

Constructors

Constructor and Description
MarkdownConverter(InputStream sourceStream) Create converter from an InputStream.
MarkdownConverter(InputStream sourceStream, LoadOptions providedLoadOptions) Create converter from an InputStream + optional LoadOptions.
MarkdownConverter(String sourcePath) Create converter from a file path.
MarkdownConverter(String sourcePath, LoadOptions providedLoadOptions) Create converter from a file path with explicit load options.

Method Summary

Modifier and Type	Method and Description
void	close() Close and release resources.
DocumentConverterResult	convert() Convert to Markdown and return result string.
DocumentConverterResult	convert(DocumentConverterOptions converterOptions) Convert with explicit options and return markdown string.
DocumentConverterResult	convert(OutputStream outputStream) Convert and write result to provided OutputStream.
DocumentConverterResult	convert(OutputStream outputStream, DocumentConverterOptions converterOptions) Convert with explicit options to provided OutputStream.
DocumentConverterResult	convertToFile(String outputFilePath) Convert and save to file path.
DocumentConverterResult	convertToFile(String outputFilePath, DocumentConverterOptions converterOptions) Convert with explicit options and save to a file path.
com.groupdocs.markdown.licensing.IMeteredCounter	getMeteredCounter() Expose meteredCounter for tests or callers (if needed).

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownConverter

public MarkdownConverter(String sourcePath)
                  throws IOException

Create converter from a file path.

Parameters:

sourcePath - path to source file

Throws:

IllegalArgumentException - if sourcePath null/empty

FileNotFoundException - if file does not exist

UnsupportedOperationException - if file type can't be detected / no converter

IOException

MarkdownConverter

public MarkdownConverter(String sourcePath,
                         LoadOptions providedLoadOptions)
                  throws IOException

Create converter from a file path with explicit load options.

Throws:

IOException

MarkdownConverter

public MarkdownConverter(InputStream sourceStream)
                  throws IOException

Create converter from an InputStream. The constructor will copy the stream into memory (so caller still owns original stream).

Parameters:

sourceStream - input stream (must not be null)

Throws:

IllegalArgumentException - if sourceStream null

UnsupportedOperationException - if file type can't be detected / no converter

IOException

MarkdownConverter

public MarkdownConverter(InputStream sourceStream,
                         LoadOptions providedLoadOptions)
                  throws IOException

Create converter from an InputStream + optional LoadOptions.

Throws:

IOException

Method Detail

convert

public DocumentConverterResult convert()

Convert to Markdown and return result string.

convert

public DocumentConverterResult convert(OutputStream outputStream)

Convert and write result to provided OutputStream.

convertToFile

public DocumentConverterResult convertToFile(String outputFilePath)

Convert and save to file path.

convert

public DocumentConverterResult convert(DocumentConverterOptions converterOptions)

Convert with explicit options and return markdown string.

convert

public DocumentConverterResult convert(OutputStream outputStream,
                                       DocumentConverterOptions converterOptions)

Convert with explicit options to provided OutputStream.

convertToFile

public DocumentConverterResult convertToFile(String outputFilePath,
                                             DocumentConverterOptions converterOptions)

Convert with explicit options and save to a file path.

close

public void close()

Close and release resources.

Specified by:

close in interface AutoCloseable

getMeteredCounter

public com.groupdocs.markdown.licensing.IMeteredCounter getMeteredCounter()

Expose meteredCounter for tests or callers (if needed).