Packages

com.groupdocs.conversion

Classes

java.lang.Object
- com.groupdocs.conversion.Converter

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class Converter
extends Object
implements Closeable
```
Represents main class that controls document conversion process.

Constructor Summary

Constructors
Constructor and Description
`Converter(InputStream document)` Initializes new instance of `Converter` class.
`Converter(InputStream document, ConverterSettings settings)` Initializes new instance of `Converter` class.
`Converter(InputStream document, com.groupdocs.conversion.contracts.Func1<FileType,LoadOptions> loadOptions)` Initializes new instance of class.
`Converter(InputStream document, com.groupdocs.conversion.contracts.Func1<FileType,LoadOptions> loadOptions, ConverterSettings settings)` Initializes new instance of class.
`Converter(InputStream document, LoadOptions loadOptions)` Initializes new instance of `Converter` class.
`Converter(InputStream document, LoadOptions loadOptions, ConverterSettings settings)` Initializes new instance of `Converter` class.
`Converter(String filePath)` Initializes new instance of `Converter` class.
`Converter(String filePath, ConverterSettings settings)` Initializes new instance of `Converter` class.
`Converter(String filePath, com.groupdocs.conversion.contracts.Func1<FileType,LoadOptions> loadOptions)` Initializes new instance of class.
`Converter(String filePath, com.groupdocs.conversion.contracts.Func1<FileType,LoadOptions> loadOptions, ConverterSettings settings)` Initializes new instance of class.
`Converter(String filePath, LoadOptions loadOptions)` Initializes new instance of `Converter` class.
`Converter(String filePath, LoadOptions loadOptions, ConverterSettings settings)` Initializes new instance of `Converter` class.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`convert(OutputStream document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)` Converts source document.
`void`	`convert(OutputStream document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)` Converts source document.
`void`	`convert(OutputStream document, ConvertOptions convertOptions)` Converts source document.
`void`	`convert(OutputStream document, com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)` Converts source document.
`void`	`convert(SaveDocumentStream document, ConvertedDocumentStream documentCompleted, com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)` Converts source document.
`void`	`convert(SaveDocumentStream document, com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)` Converts source document.
`void`	`convert(com.groupdocs.conversion.contracts.SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, ConvertOptions convertOptions)` Converts source document.
`void`	`convert(com.groupdocs.conversion.contracts.SaveDocumentStreamForFileType document, ConvertedDocumentStream documentCompleted, com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)` Converts source document.
`void`	`convert(com.groupdocs.conversion.contracts.SaveDocumentStreamForFileType document, ConvertOptions convertOptions)` Converts source document.
`void`	`convert(com.groupdocs.conversion.contracts.SaveDocumentStreamForFileType document, com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)` Converts source document.
`void`	`convert(SavePageStream document, ConvertedPageStream documentCompleted, com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)` Converts source document.
`void`	`convert(com.groupdocs.conversion.contracts.SavePageStreamForFileType document, ConvertedPageStream documentCompleted, ConvertOptions convertOptions)` Converts source document.
`void`	`convert(com.groupdocs.conversion.contracts.SavePageStreamForFileType document, ConvertedPageStream documentCompleted, com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)` Converts source document.
`void`	`convert(com.groupdocs.conversion.contracts.SavePageStreamForFileType document, ConvertOptions convertOptions)` Converts source document.
`void`	`convert(com.groupdocs.conversion.contracts.SavePageStreamForFileType document, com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)` Converts source document.
`void`	`convert(String filePath, ConvertOptions convertOptions)` Converts source document.
`void`	`convertPageByPage(OutputStream document, ConvertOptions convertOptions)` Converts source document.
`void`	`dispose()` Releases resources.
`static List<PossibleConversions>`	`getAllPossibleConversions()` Gets all supported conversions Learn more Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code
`IDocumentInfo`	`getDocumentInfo()` Gets source document info - pages count and other document properties specific to the file type.
`PossibleConversions`	`getPossibleConversions()` Gets possible conversions for the source document.
`static PossibleConversions`	`getPossibleConversions(String extension)` Gets supported conversions for provided document extension Converter.GetPossibleConversions(".docx") Converter.GetPossibleConversions("docx") Learn more Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code
`static void`	`tweakPackageUtil(String vendor, String version, String specTitle)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Converter
```
public Converter(InputStream document)
```
    Initializes new instance of Converter class.
    
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    document - readable stream.
    
    Throws:
    
    com.aspose.ms.System.ArgumentNullException - Thrown when document is null.
  - Converter
```
public Converter(InputStream document,
         ConverterSettings settings)
```
    Initializes new instance of Converter class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    document - A readable stream.
    settings - The Converter settings.
  - Converter
```
public Converter(InputStream document,
         LoadOptions loadOptions)
```
    Initializes new instance of Converter class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    document - A readable stream.
    loadOptions - The load options.
  - Converter
```
public Converter(InputStream document,
         LoadOptions loadOptions,
         ConverterSettings settings)
```
    Initializes new instance of Converter class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    document - A readable stream.
    loadOptions - The document load options.
    settings - The Converter settings.
  - Converter
```
public Converter(InputStream document,
         com.groupdocs.conversion.contracts.Func1<FileType,LoadOptions> loadOptions)
```
    Initializes new instance of class. Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    document - A readable stream.
    loadOptions - The methods that returns document load options.
  - Converter
```
public Converter(InputStream document,
         com.groupdocs.conversion.contracts.Func1<FileType,LoadOptions> loadOptions,
         ConverterSettings settings)
```
    Initializes new instance of class. Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    document - The method that returns readable stream.
    loadOptions - The methods that returns document load options.
    settings - The Converter settings.
  - Converter
```
public Converter(String filePath)
```
    Initializes new instance of Converter class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    filePath - The file path to the source document.
  - Converter
```
public Converter(String filePath,
         ConverterSettings settings)
```
    Initializes new instance of Converter class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    filePath - The file path to the source document.
    settings - The Converter settings.
  - Converter
```
public Converter(String filePath,
         LoadOptions loadOptions)
```
    Initializes new instance of Converter class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    filePath - The file path to the source document.
    loadOptions - The load options.
  - Converter
```
public Converter(String filePath,
         LoadOptions loadOptions,
         ConverterSettings settings)
```
    Initializes new instance of Converter class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    filePath - The file path to the source document.
    loadOptions - The document load options.
    settings - The Converter settings.
  - Converter
```
public Converter(String filePath,
         com.groupdocs.conversion.contracts.Func1<FileType,LoadOptions> loadOptions)
```
    Initializes new instance of class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    filePath - The file path to the source document.
    loadOptions - The document load options.
  - Converter
```
public Converter(String filePath,
         com.groupdocs.conversion.contracts.Func1<FileType,LoadOptions> loadOptions,
         ConverterSettings settings)
```
    Initializes new instance of class.
    Learn more More about how to load and convert documents stored at FTP, Amazon S3 Storage, Windows Azure or any other third-party storage: Loading document from different sources More about document loading options dependent on file type: Load options for different document types
    
    Parameters:
    filePath - The file path to the source document.
    loadOptions - The document load options.
    settings - The Converter settings.
- Method Detail
  - tweakPackageUtil
```
public static void tweakPackageUtil(String vendor,
                    String version,
                    String specTitle)
                             throws NoSuchFieldException,
                                    SecurityException,
                                    IllegalArgumentException,
                                    IllegalAccessException,
                                    ClassNotFoundException
```
    Throws:
    
    NoSuchFieldException
    
    SecurityException
    
    IllegalArgumentException
    
    IllegalAccessException
    
    ClassNotFoundException
  - convert
```
public final void convert(OutputStream document,
           ConvertOptions convertOptions)
```
    Converts source document. Saves the whole converted document.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The output stream.
    convertOptions - The convert options specific to desired target file type.
  - convert
```
public void convert(OutputStream document,
           ConvertedDocumentStream documentCompleted,
           ConvertOptions convertOptions)
```
    Converts source document. Saves the whole converted document. Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - output stream
    documentCompleted - the delegate that receive converted document stream.
    convertOptions - the convert options specific to desired target file type.
  - convert
```
public void convert(SaveDocumentStream document,
           com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)
```
    Converts source document. Saves the whole converted document.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The stream.
    convertOptionsProvider - Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
  - convert
```
public void convert(SaveDocumentStream document,
           ConvertedDocumentStream documentCompleted,
           com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)
```
    Converts source document. Saves the whole converted document.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The stream.
    documentCompleted - The delegate that receive converted document stream.
    convertOptionsProvider - Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
  - convert
```
public void convert(com.groupdocs.conversion.contracts.SaveDocumentStreamForFileType document,
           ConvertOptions convertOptions)
```
    Converts source document. Saves the whole converted document.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document to a stream.
    convertOptions - The convert options specific to desired target file type.
  - convert
```
public void convert(com.groupdocs.conversion.contracts.SaveDocumentStreamForFileType document,
           ConvertedDocumentStream documentCompleted,
           ConvertOptions convertOptions)
```
    Converts source document. Saves the whole converted document.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document to a stream
    documentCompleted - The delegate that receive converted document stream
    convertOptions - The convert options specific to desired target file type
  - convert
```
public void convert(com.groupdocs.conversion.contracts.SaveDocumentStreamForFileType document,
           com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)
```
    Converts source document. Saves the whole converted document.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document to a stream.
    convertOptionsProvider - Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
  - convert
```
public void convert(com.groupdocs.conversion.contracts.SaveDocumentStreamForFileType document,
           ConvertedDocumentStream documentCompleted,
           com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)
```
    Converts source document. Saves the whole converted document.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document to a stream.
    documentCompleted - The delegate that receive converted document stream.
    convertOptionsProvider - Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
  - convert
```
public final void convert(String filePath,
           ConvertOptions convertOptions)
```
    Converts source document. Saves the whole converted document.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    filePath - The file path to the source document.
    convertOptions - The convert options specific to desired target file type.
  - convertPageByPage
```
public final void convertPageByPage(OutputStream document,
                     ConvertOptions convertOptions)
```
    Converts source document. Saves the converted document page by page.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The output stream.
    convertOptions - The convert options specific to desired target file type.
  - convert
```
public void convert(OutputStream document,
           ConvertedPageStream documentCompleted,
           ConvertOptions convertOptions)
```
    Converts source document. Saves the converted document page by page. Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The output stream.
    documentCompleted - The delegate that receive converted document page stream.
    convertOptions - The convert options specific to desired target file type.
  - convert
```
public void convert(OutputStream document,
           com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)
```
    Converts source document. Saves the converted document page by page.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The output stream.
    convertOptionsProvider - Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
  - convert
```
public void convert(SavePageStream document,
           ConvertedPageStream documentCompleted,
           com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)
```
    Converts source document. Saves the converted document page by page.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document page to a stream.
    documentCompleted - The delegate that receive converted document page stream.
    convertOptionsProvider - Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
  - convert
```
public void convert(com.groupdocs.conversion.contracts.SavePageStreamForFileType document,
           ConvertOptions convertOptions)
```
    Converts source document. Saves the converted document page by page.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document to a stream.
    convertOptions - The convert options specific to desired target file type.
  - convert
```
public void convert(com.groupdocs.conversion.contracts.SavePageStreamForFileType document,
           ConvertedPageStream documentCompleted,
           ConvertOptions convertOptions)
```
    Converts source document. Saves the converted document page by page.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document page to a stream.
    documentCompleted - The delegate that receive converted document page stream.
    convertOptions - The convert options specific to desired target file type.
  - convert
```
public void convert(com.groupdocs.conversion.contracts.SavePageStreamForFileType document,
           com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)
```
    Converts source document. Saves the converted document page by page.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document to a stream.
    convertOptionsProvider - Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
  - convert
```
public void convert(com.groupdocs.conversion.contracts.SavePageStreamForFileType document,
           ConvertedPageStream documentCompleted,
           com.groupdocs.conversion.contracts.ConvertOptionsProvider convertOptionsProvider)
```
    Converts source document. Saves the converted document page by page.
    Learn more More about document conversion basic scenarios: How to convert document in 3 steps Conversion use cases, advanced settings and customizations: Convert document with advanced settings
    
    Parameters:
    document - The delegate that saves converted document page to a stream.
    documentCompleted - The delegate that receive converted document page stream.
    convertOptionsProvider - Convert options provider. Will be called for each conversion to provide specific convert options to desired target document type.
  - getDocumentInfo
```
public final IDocumentInfo getDocumentInfo()
```
    Gets source document info - pages count and other document properties specific to the file type.
    Learn more Learn more about converted document - file type, pages count, creation date and many other format specific properties: How to get document info
    
    Returns:
    document info
  - getPossibleConversions
```
public final PossibleConversions getPossibleConversions()
```
    Gets possible conversions for the source document.
    Learn more Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code
    
    Returns:
    possible conversions
  - getAllPossibleConversions
```
public static List<PossibleConversions> getAllPossibleConversions()
```
    Gets all supported conversions Learn more Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code
    
    Returns:
    supported conversions
  - getPossibleConversions
```
public static PossibleConversions getPossibleConversions(String extension)
```
    Gets supported conversions for provided document extension Converter.GetPossibleConversions(".docx") Converter.GetPossibleConversions("docx") Learn more Learn more about supported conversions: Full list of supported conversions Learn more about available conversions: How to get supported conversions in code
    
    Parameters:
    extension - Document extension
    
    Returns:
    possible conversions
  - dispose
```
public final void dispose()
```
    Releases resources.
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable

Packages

com.groupdocs.conversion

Classes

Class Converter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Converter

Converter

Converter

Converter

Converter

Converter

Converter

Converter

Converter

Converter

Converter

Converter

Method Detail

tweakPackageUtil

convert

convert

convert

convert

convert

convert

convert

convert

convert

convertPageByPage

convert

convert

convert

convert

convert

convert

convert

getDocumentInfo

getPossibleConversions

getAllPossibleConversions

getPossibleConversions

dispose

close