GroupDocs.Conversion for Java 20.10 Release Notes

Major Features

There are 20+ features, improvements and bug-fixes in this release, most notable are:

• Conversions from PST, OST - can convert each message, contact to different format
• Now is possible to convert each email attachment to different format
• Conversions from Oxps, Fods, Otg
• Conversion to Fods
• Improved caching
• Introduced in-memory caching
• Conversions from/to Md (markdown)
• Conversions from/to Fodp
• XML can be used as data source for conversion
• Improved pst/ost documents info

Full List of Issues Covering all Changes in this Release

Public API and Backward Incompatible Changes

1. Converter class has new constructor overloads

/**
* Initializes new instance of Converter class.
* @param document    A readable stream.
* @param loadOptions The methods that returns document load options.
*/
public Converter(InputStream document, Func1<FileType, LoadOptions> loadOptions)
 
 
 /**
 * Initializes new instance of Converter class.
 * @param document    The method that returns readable stream.
 * @param loadOptions The methods that returns document load options.
 * @param settings    The Converter settings.
 */
 public Converter(InputStream document, Func1<FileType, LoadOptions> loadOptions, ConverterSettings settings)
 
 /**
 * Initializes new instance of Converter class.
 * @param filePath    The file path to the source document.
 * @param loadOptions The document load options.
 */
 public Converter(String filePath, Func1<FileType, LoadOptions> loadOptions)
 
 /**
 * Initializes new instance of Converter class.
 * @param filePath    The file path to the source document.
 * @param loadOptions The document load options.
 * @param settings    The Converter settings.
 */
 public Converter(String filePath, Func1<FileType, LoadOptions> loadOptions, ConverterSettings settings) 

Usage

Func1<FileType, LoadOptions> loadOptions = new Func1<FileType, LoadOptions>() {
	@Override
	public LoadOptions invoke(FileType sourceType) {
		if (sourceType == EmailFileType.Msg) {
			EmailLoadOptions emailLoadOptions = new EmailLoadOptions();
			emailLoadOptions.setConvertOwned(true);
			emailLoadOptions.setConvertOwner(true);
			return emailLoadOptions;
		}
		return null;
	}
};
String source = "sample.docx";
Converter converter = new Converter(source, loadOptions);
try {
	...
} finally {
	converter.dispose();
}

2. Convert method in Converter class has new overloads

   /**
   * Converts source document. Saves the whole converted document.
   * @param document               The stream.
   * @param convertOptionsProvider Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
   */
   public void convert(SaveDocumentStream document, ConvertOptionsProvider convertOptionsProvider) 
    
   /**
   * Converts source document. Saves the whole converted document.
   * @param document               The stream.
   * @param documentCompleted      The delegate that receive converted document stream.
   * @param convertOptionsProvider Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
   */
   public void convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
   
   /**
   * Converts source document. Saves the whole converted document.
   * @param document       The delegate that saves converted document to a stream.
   * @param convertOptions The convert options specific to desired target file type.
   */
   public void convert(SaveDocumentStreamForFileType document, ConvertOptions convertOptions)
   
   /**
   * Converts source document. Saves the whole converted document.
   * @param document          The delegate that saves converted document to a stream
   * @param documentCompleted The delegate that receive converted document stream
   * @param convertOptions    The convert options specific to desired target file type
   */
   public void convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)
   
   /**
   * Converts source document. Saves the whole converted document.
   * @param document               The delegate that saves converted document to a stream.
   * @param convertOptionsProvider Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
   */
   public void convert(SaveDocumentStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
   
   /**
   * Converts source document. Saves the whole converted document.
   * @param document               The delegate that saves converted document to a stream.
   * @param documentCompleted      The delegate that receive converted document stream.
   * @param convertOptionsProvider Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
   */
   public void convert(SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
   
   /**
   * Converts source document. Saves the converted document page by page.
   * @param document       The output stream.
   * @param convertOptions The convert options specific to desired target file type.
   */
   public final void convertPageByPage(final OutputStream document, final ConvertOptions convertOptions)
   
   /**
   * Converts source document. Saves the converted document page by page.
   * @param document          The output stream.
   * @param documentCompleted The delegate that receive converted document page stream.
   * @param convertOptions    The convert options specific to desired target file type.
   */
   public void convert(final OutputStream document, ConvertedPageStream documentCompleted, final ConvertOptions convertOptions)
   
   /**
   * Converts source document. Saves the converted document page by page.
   * @param document               The output stream.
   * @param convertOptionsProvider Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
   */
   public void convert(final OutputStream document, ConvertOptionsProvider convertOptionsProvider)
   
   /**
   * Converts source document. Saves the converted document page by page.
   * @param document          The delegate that saves converted document page to a stream.
   * @param documentCompleted The delegate that receive converted document page stream.
   * @param convertOptions    The convert options specific to desired target file type.
   */
   public void convert(SavePageStreamForFileType document, ConvertedPageStream documentCompleted, final ConvertOptions convertOptions)
   
   /**
   * Converts source document. Saves the converted document page by page.
   * @param document               The delegate that saves converted document to a stream.
   * @param convertOptionsProvider Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
   */
   public void convert(SavePageStreamForFileType document, ConvertOptionsProvider convertOptionsProvider)
   
   /**
   * Converts source document. Saves the converted document page by page.
   * @param document               The delegate that saves converted document page to a stream.
   * @param documentCompleted      The delegate that receive converted document page stream.
   * @param convertOptionsProvider Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
   */
   public void convert(final SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptionsProvider convertOptionsProvider)
   

   Usage

   Func1<FileType, LoadOptions> loadOptionsProvider = new Func1<FileType, LoadOptions>() {
       @Override
       public LoadOptions invoke(FileType sourceType) {
           if (sourceType == EmailFileType.Msg) {
               EmailLoadOptions emailLoadOptions = new EmailLoadOptions();
               emailLoadOptions.setConvertOwned(true);
               emailLoadOptions.setConvertOwner(true);
               return emailLoadOptions;
           }
           return null;
       }
   };
   
   SaveDocumentStream stream = new SaveDocumentStream() {
       @Override
          public Stream invoke() {
           return new FileStream("converted-{index++}.{targetType.Extension}", FileMode.Create);
       }
   };
   
   ConvertOptionsProvider convertOptionsProvider = new ConvertOptionsProvider() {
       @Override
       public ConvertOptions invoke(String sourceDocumentName, FileType sourceType) {
           if (sourceType == WordProcessingFileType.Doc) {
               ImageConvertOptions result = new ImageConvertOptions();
               result.setFormat(ImageFileType.Tiff);
               return result;
           } else if (sourceType == EmailFileType.Msg) {
               return new PdfConvertOptions();
           } else if (sourceType == ImageFileType.Png) {
               ImageConvertOptions result = new ImageConvertOptions();
               result.setFormat(ImageFileType.Jpeg);
               return result;
           }
           return new PdfConvertOptions();
       }
   };
   
   String source = "sample.docx";
   Converter converter = new Converter(source, loadOptionsProvider);
   try {
       Converter.convert(stream, convertOptionsProvider);
   } finally {
       converter.dispose();
   }
   

3. New delegates are introduced

   /**
    * Describes delegate for saving converted document into stream.
    */
   public abstract class SaveDocumentStreamForFileType
   /**
   * <p>
   * Saves converted document into stream.
   * </p>
   * @param fileType Converted document type
   * @return Must return a stream where the converted document will be saved
   */
   public abstract Stream invoke(FileType fileType);
   
   **
    * Describes delegate for saving converted document page into stream.
    */
   public abstract class SavePageStreamForFileType    
   /**
   * <p>
   * Saves converted document page into stream.
   * </p>
   * @param pageNumber Converted page number
   * @param fileType Converted document type
   * @return Must return a stream where the converted document page will be saved
   */
   public abstract Stream invoke(int pageNumber, FileType fileType)
   
   /**
    * Describes delegate to provide convert options for specific source document.
    * The delegate will be called before each conversion and provide a chance to provide specific convert options for desired target conversion.
    * The decision could be made based on provided source file name and source file type.
    */
   public abstract class ConvertOptionsProvider
   /**
   * <p>
   * Provides convert options for specific source document.
   * </p>
   *
   * @param sourceDocumentName Source file name
   * @param sourceType         Source file type
   * @return Must return ConvertOptions to be used for conversion of FileType sourceType< document
   */
   public abstract ConvertOptions invoke(String sourceDocumentName, FileType sourceType)
   

4. FormatingOptions in PdfOptions class is marked as obsolete FormattingOptions must be used

5. DefaultFont in GroupDocs.Conversion.ConverterSettings class is marked as obsolete DefaultFont in specific ConvertOptions instance must be used.

6. ConvertAttachments in EmailLoadOptions class is marked as obsolete ConvertOwned must be used

7. Introduced new class GroupDocs.Conversion.Contracts.PersonalStorageDocumentInfo

   /**
    * Contains personal storage document metadata
    */
   public class PersonalStorageDocumentInfo extends DocumentInfo {  
   
       public PersonalStorageDocumentInfo(PersonalStorage storage, FileType format, long size) 
   
       /**
        * Is storage password protected
        */
       public boolean isPasswordProtected() 
   
       /**
        * Root folder name
        *
        * @return Root folder name
        */
       public String getRootFolderName() 
   
       /**
        * Get count of contents in the root folder
        *
        * @return count of contents in the root folder
        */
       public int getContentCount() 
   
       /**
        * Folders in the storage
        *
        * @return Folders in the storage
        */
       public List<String> getFolders() 
   }
   

   Usage

   String source = "ContactsExport.pst";
   Converter converter = new Converter(source);
   try {
       IDocumentInfo documentInfo = converter.getDocumentInfo();
       PersonalStorageDocumentInfo pstInfo = (PersonalStorageDocumentInfo) documentInfo;
       for(String folder : pstInfo.getFolders())
       {
           System.out.println(folder);
       }
   } finally {
       converter.dispose();
   }
   

8. Introduced new property in class XmlLoadOptions

   /**
    * Use Xml document as data source
    * @return true if use
    */
   public boolean isUseAsDataSource()
   
   /**
    * Set use Xml document as data source
    * @param useAsDataSource use Xml document as data source
    */
   public void setUseAsDataSource(boolean useAsDataSource) 
   

   Usage

   String source = "sample.xml";
   Converter converter = new Converter(source, new Func1<FileType, LoadOptions>() {
       @Override
       public LoadOptions invoke(FileType arg) {
           XmlLoadOptions loadOptions = new XmlLoadOptions();
           loadOptions.setUseAsDataSource(true);
           return loadOptions;
       }
   });
   try {
       SpreadsheetConvertOptions options = new SpreadsheetConvertOptions();
       converter.convert("converted.xlsx" , options);
   } finally {
       converter.dispose();
   }