com.groupdocs.markdown

Class DocumentConverterResult

java.lang.Object

com.groupdocs.markdown.DocumentConverterResult

public class DocumentConverterResult
extends Object

Represents the result of a document conversion operation to Markdown format.

This class provides information about the success or failure of a document conversion operation. When the conversion is successful, it contains the converted Markdown content. When the conversion fails, it contains error information including an error message and exception details.

Example usage:

 try (MarkdownConverter converter = new MarkdownConverter("document.docx")) {
     DocumentConverterResult result = converter.convert();

     if (result.isSuccess()) {
         // Use the converted Markdown content
         System.out.println(result.getContent());
     } else {
         // Handle the conversion error
         System.err.println("Conversion failed: " + result.getErrorMessage());
         if (result.getException() != null) {
             result.getException().printStackTrace();
         }
     }
 }
 

Method Summary

Modifier and Type	Method and Description
static DocumentConverterResult	failure(String errorMessage, Exception exception) Creates a failed conversion result with error information.
String	getContent() Gets the converted Markdown content.
String	getErrorMessage() Gets the error message if the conversion failed.
Exception	getException() Gets the exception that occurred during conversion, if any.
boolean	isSuccess() Gets whether the conversion was successful.
static DocumentConverterResult	success() Creates a successful conversion result without Markdown content.
static DocumentConverterResult	success(String content) Creates a successful conversion result with Markdown content.

Methods inherited from class java.lang.Object

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

Method Detail

isSuccess

public boolean isSuccess()

Gets whether the conversion was successful.

Returns:

true if the conversion was successful; otherwise, false.

getErrorMessage

public String getErrorMessage()

Gets the error message if the conversion failed.

Returns:

The error message describing why the conversion failed, or null if successful.

getContent

public String getContent()

Gets the converted Markdown content.

Returns:

The Markdown content as a string, or null if conversion failed or the content was written to a stream or file.

getException

public Exception getException()

Gets the exception that occurred during conversion, if any.

Returns:

The exception that caused the conversion to fail, or null if successful.

success

public static DocumentConverterResult success()

Creates a successful conversion result without Markdown content.

This method is typically used when the converted content is written to a stream or file.

Returns:

A DocumentConverterResult indicating a successful conversion.

success

public static DocumentConverterResult success(String content)

Creates a successful conversion result with Markdown content.

Parameters:

content - The converted Markdown content.

Returns:

A DocumentConverterResult containing the converted Markdown content.

Throws:

IllegalArgumentException - if content is null.

failure

public static DocumentConverterResult failure(String errorMessage,
                                              Exception exception)

Creates a failed conversion result with error information.

Parameters:

errorMessage - The error message describing why the conversion failed.

exception - The exception that caused the conversion to fail.

Returns:

A DocumentConverterResult containing the error information.

Throws:

IllegalArgumentException - if errorMessage is null.