com.groupdocs.merger

Class Merger

java.lang.Object

com.groupdocs.merger.Merger

public class Merger
extends Object

Represents the main class that controls the document merging process.

Constructor Summary

Constructors

Constructor and Description
Merger(InputStream document) Initializes new instance of Merger class.
Merger(InputStream document, ILoadOptions loadOptions) Initializes new instance of Merger class.
Merger(InputStream document, ILoadOptions loadOptions, MergerSettings settings) Initializes new instance of Merger class.
Merger(InputStream document, MergerSettings settings) Initializes new instance of Merger class.
Merger(String filePath) Initializes new instance of Merger class.
Merger(String filePath, ILoadOptions loadOptions) Initializes new instance of Merger class.
Merger(String filePath, ILoadOptions loadOptions, MergerSettings settings) Initializes new instance of Merger class.
Merger(String filePath, MergerSettings settings) Initializes new instance of Merger class.

Method Summary

Modifier and Type	Method and Description
void	addPassword(IAddPasswordOptions addPasswordOptions) Protects document with password.
void	applyPageBuilder(com.groupdocs.merger.domain.builders.PageBuilder pageBuilder) Applies page builder changes.
void	changeOrientation(IOrientationOptions orientationOptions) Applies a new orientation mode for the specified pages.
com.groupdocs.merger.domain.builders.PageBuilder	createPageBuilder() Creates a new Page builder with predefined document collection.
com.groupdocs.merger.domain.builders.PageBuilder	createPageBuilder(com.groupdocs.merger.domain.options.PageBuilderOptions pageBuilderOptions) Creates a new Page builder with predefined document collection.
void	dispose() Disposes resources.
void	extractPages(IExtractOptions extractOptions) Makes a new document with some pages from the source document.
void	generatePreview(IPreviewOptions previewOptions) Generates document pages preview.
IDocumentInfo	getDocumentInfo() Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.
void	importDocument(IImportDocumentOptions importDocumentOptions) Imports the document as attachment or embedded via Ole.
boolean	isPasswordSet() Checks whether document is password protected.
void	join(InputStream document) Joins the documents into one single document.
void	join(InputStream document, IImageJoinOptions joinOptions) Joins the documents into one single document.
void	join(InputStream document, IJoinOptions joinOptions) Joins the documents into one single document.
void	join(InputStream document, com.groupdocs.merger.domain.options.interfaces.IPageJoinOptions joinOptions) Joins the documents into one single document.
void	join(String filePath) Joins the documents into one single document.
void	join(String filePath, IImageJoinOptions joinOptions) Joins the documents into one single document.
void	join(String filePath, IJoinOptions joinOptions) Joins the documents into one single document.
void	join(String filePath, com.groupdocs.merger.domain.options.interfaces.IPageJoinOptions joinOptions) Joins the documents into one single document.
void	movePage(IMoveOptions moveOptions) Moves page to a new position within document of known format.
void	removePages(IRemoveOptions removeOptions) Removes pages from document of known format.
void	removePassword() Removes password from document.
void	rotatePages(IRotateOptions rotateOptions) Rotate pages of the document.
void	save(OutputStream document) Saves the result document to the stream document.
void	save(String filePath) Saves the result document file to filePath.
void	save(String filePath, boolean useDefaultDirectory) Saves the result document file to filePath.
void	split(ISplitOptions splitOptions) Splits the single document to the multiple documents.
void	split(ITextSplitOptions splitOptions) Splits the single document to the multiple documents.
void	swapPages(ISwapOptions swapOptions) Swaps two pages within document of known format.
void	updatePassword(IUpdatePasswordOptions updatePasswordOptions) Updates existing password for document.

Methods inherited from class java.lang.Object

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

Constructor Detail

Merger

public Merger(InputStream document)
       throws Exception

Initializes new instance of Merger class.

Parameters:

document - The readable stream.

Throws:

NullPointerException - Thrown when document is null.

Exception

Merger

public Merger(InputStream document,
              ILoadOptions loadOptions)
       throws Exception

Initializes new instance of Merger class.

Parameters:

document - The readable stream.

loadOptions - The document load options.

Throws:

NullPointerException - Thrown when document is null.

NullPointerException - Thrown when loadOptions is null.

Exception

Merger

public Merger(InputStream document,
              ILoadOptions loadOptions,
              MergerSettings settings)
       throws Exception

Initializes new instance of Merger class.

Parameters:

document - The readable stream.

loadOptions - The document load options.

settings - The Merger settings.

Throws:

NullPointerException - Thrown when document is null.

NullPointerException - Thrown when loadOptions is null.

NullPointerException - Thrown when settings is null.

Exception

Merger

public Merger(InputStream document,
              MergerSettings settings)
       throws Exception

Initializes new instance of Merger class.

Parameters:

document - The readable stream.

settings - The Merger settings.

Throws:

NullPointerException - Thrown when document is null.

NullPointerException - Thrown when settings is null.

Exception

Merger

public Merger(String filePath)
       throws Exception

Initializes new instance of Merger class.

Parameters:

filePath - The file path.

Throws:

NullPointerException - Thrown when filePath is null or empty.

Exception

Merger

public Merger(String filePath,
              ILoadOptions loadOptions)
       throws Exception

Initializes new instance of Merger class.

Parameters:

filePath - The file path.

loadOptions - The document load options.

Throws:

NullPointerException - Thrown when filePath is null or empty.

NullPointerException - Thrown when loadOptions is null.

Exception

Merger

public Merger(String filePath,
              ILoadOptions loadOptions,
              MergerSettings settings)
       throws Exception

Initializes new instance of Merger class.

Parameters:

filePath - The file path.

loadOptions - The document load options.

settings - The Merger settings.

Throws:

NullPointerException - Thrown when filePath is null or empty.

NullPointerException - Thrown when loadOptions is null.

NullPointerException - Thrown when settings is null.

Exception

Merger

public Merger(String filePath,
              MergerSettings settings)
       throws Exception

Initializes new instance of Merger class.

Parameters:

filePath - The file path.

settings - The Merger settings.

Throws:

NullPointerException - Thrown when filePath is null or empty.

NullPointerException - Thrown when settings is null.

Exception

Method Detail

addPassword

public final void addPassword(IAddPasswordOptions addPasswordOptions)
                       throws Exception

Protects document with password.

Parameters:

addPasswordOptions - The options for specifying the password.

Learn more

• More about how to protect document with password: How to protect PDF, Word, Excel and PowerPoint documents with password
• More about how to update or change document password: How to change document password
• More about how to check document password protected or not: How to check document password protection
• More about how to remove document password: How to remove PDF, Word, Excel and PowerPoint documents password

Throws:

NullPointerException - Thrown when addPasswordOptions is null.

Exception

applyPageBuilder

public final void applyPageBuilder(com.groupdocs.merger.domain.builders.PageBuilder pageBuilder)
                            throws Exception

Applies page builder changes.

Parameters:

pageBuilder - The page builder.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when pageBuilder is null.

Exception

changeOrientation

public final void changeOrientation(IOrientationOptions orientationOptions)
                             throws Exception

Applies a new orientation mode for the specified pages.

Parameters:

orientationOptions - The change orientation options.

Learn more

• More about how to change orientation for Microsoft Word document pages: How to change Microsoft Word document pages orientation

Throws:

NullPointerException - Thrown when orientationOptions is null.

Exception

createPageBuilder

public final com.groupdocs.merger.domain.builders.PageBuilder createPageBuilder()
                                                                         throws Exception

Creates a new Page builder with predefined document collection.

Returns:

The created page builder.

Throws:

Exception

createPageBuilder

public final com.groupdocs.merger.domain.builders.PageBuilder createPageBuilder(com.groupdocs.merger.domain.options.PageBuilderOptions pageBuilderOptions)
                                                                         throws Exception

Creates a new Page builder with predefined document collection.

Returns:

The created page builder.

Throws:

Exception

dispose

public final void dispose()

Disposes resources.

extractPages

public final void extractPages(IExtractOptions extractOptions)
                        throws Exception

Makes a new document with some pages from the source document.

Parameters:

extractOptions - The page options.

Learn more

• More about how to extract specific document pages or page range: How to extract pages from PDF, Word, Excel and PowerPoint documents

Throws:

NullPointerException - Thrown when extractOptions is null.

Exception

generatePreview

public final void generatePreview(IPreviewOptions previewOptions)
                           throws Exception

Generates document pages preview.

Parameters:

previewOptions - The preview options.

Learn more

• Learn more about how to generate previews for document pages: How to generate document pages preview using GroupDocs.Merger

Throws:

NullPointerException - Thrown when previewOptions is null.

Exception

getDocumentInfo

public final IDocumentInfo getDocumentInfo()
                                    throws Exception

Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.

Returns:

Information about document properties.

Learn more

• Learn more about document file type, pages count, size and many other format specific properties: How to get document info using GroupDocs.Merger

Throws:

Exception

importDocument

public final void importDocument(IImportDocumentOptions importDocumentOptions)
                          throws Exception

Imports the document as attachment or embedded via Ole.

Parameters:

importDocumentOptions - The embedded document import options.

Learn more

• More about adding attachment to PDF documents: How to add attachment to PDF document.
• More about adding document to Word processing via OLE: Add document to Word processing via OLE.
• More about adding document to Presentation via OLE: Add document to Presentation via OLE.
• More about adding document to Spreadsheet via OLE: Add document to Spreadsheet via OLE.
• More about adding document to Diagram via OLE: Add document to Diagram via OLE.

Throws:

NullPointerException - Thrown when importDocumentOptions is null.

Exception

isPasswordSet

public final boolean isPasswordSet()
                            throws Exception

Checks whether document is password protected.

Returns:

Returns a value indicating whether document is protected or not.

Learn more

• More about how to protect document with password: How to protect PDF, Word, Excel and PowerPoint documents with password
• More about how to update or change document password: How to change document password
• More about how to check document password protected or not: How to check document password protection
• More about how to remove document password: How to remove PDF, Word, Excel and PowerPoint documents password

Throws:

Exception

join

public final void join(InputStream document)
                throws Exception

Joins the documents into one single document.

Parameters:

document - Joined document.

Learn more

• More about document merge scenarios and use cases: How to merge PDF, Word, Excel and PowerPoint documents in 3 steps

Throws:

NullPointerException - Thrown when document is null.

Exception

join

public final void join(InputStream document,
                       IImageJoinOptions joinOptions)
                throws Exception

Joins the documents into one single document.

Parameters:

document - Joined document.

joinOptions - The image join options.

<b>Learn more</b>

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when document is null.

com.aspose.ms.System.ArgumentNullException - Thrown when joinOptions is null.

Exception

join

public final void join(InputStream document,
                       IJoinOptions joinOptions)
                throws Exception

Joins the documents into one single document.

Parameters:

document - Joined document.

joinOptions - The join options.

Learn more

• More about document merge scenarios and use cases: How to merge PDF, Word, Excel and PowerPoint documents in 3 steps

Throws:

NullPointerException - Thrown when document is null.

NullPointerException - Thrown when joinOptions is null.

Exception

join

public final void join(InputStream document,
                       com.groupdocs.merger.domain.options.interfaces.IPageJoinOptions joinOptions)
                throws Exception

Joins the documents into one single document.

Parameters:

document - Joined document.

joinOptions - The join options.

<b>Learn more</b>

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when document is null.

com.aspose.ms.System.ArgumentNullException - Thrown when joinOptions is null.

Exception

join

public final void join(String filePath)
                throws Exception

Joins the documents into one single document.

Parameters:

filePath - File path of the joined document.

Learn more

• More about document merge scenarios and use cases: How to merge PDF, Word, Excel and PowerPoint documents in 3 steps

Throws:

NullPointerException - Thrown when filePath is null or empty.

Exception

join

public final void join(String filePath,
                       IImageJoinOptions joinOptions)
                throws Exception

Joins the documents into one single document.

Parameters:

filePath - File path of the joined document.

joinOptions - The image join options.

<b>Learn more</b>

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when filePath is null or empty.

com.aspose.ms.System.ArgumentNullException - Thrown when joinOptions is null.

Exception

join

public final void join(String filePath,
                       IJoinOptions joinOptions)
                throws Exception

Joins the documents into one single document.

Parameters:

filePath - File path of the joined document.

joinOptions - The join options.

Learn more

• More about document merge scenarios and use cases: How to merge PDF, Word, Excel and PowerPoint documents in 3 steps

Throws:

NullPointerException - Thrown when filePath is null or empty.

NullPointerException - Thrown when joinOptions is null.

Exception

join

public final void join(String filePath,
                       com.groupdocs.merger.domain.options.interfaces.IPageJoinOptions joinOptions)
                throws Exception

Joins the documents into one single document.

Parameters:

filePath - File path of the joined document.

joinOptions - The join options.

<b>Learn more</b>

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when filePath is null or empty.

com.aspose.ms.System.ArgumentNullException - Thrown when joinOptions is null.

Exception

movePage

public final void movePage(IMoveOptions moveOptions)
                    throws Exception

Moves page to a new position within document of known format.

Parameters:

moveOptions - The move options.

Learn more

• More about how to move page to another position within document: How to move PDF, Word, Excel and PowerPoint document pages

Throws:

NullPointerException - Thrown when moveOptions is null.

Exception

removePages

public final void removePages(IRemoveOptions removeOptions)
                       throws Exception

Removes pages from document of known format.

Parameters:

removeOptions - The options for the numbers of pages to be removed.

Learn more

• More about how to remove page from document: How to remove page from PDF, Word, Excel or PowerPoint document

Throws:

NullPointerException - Thrown when removeOptions is null.

Exception

removePassword

public final void removePassword()
                          throws Exception

Removes password from document.

Learn more

• More about how to protect document with password: How to protect PDF, Word, Excel and PowerPoint documents with password
• More about how to update or change document password: How to change document password
• More about how to check document password protected or not: How to check document password protection
• More about how to remove document password: How to remove PDF, Word, Excel and PowerPoint documents password

Throws:

Exception

rotatePages

public final void rotatePages(IRotateOptions rotateOptions)
                       throws Exception

Rotate pages of the document.

Parameters:

rotateOptions - The options for the page rotating.

Learn more

• More about how to rotate PDF document pages: How to rotate PDF document pages

Throws:

NullPointerException - Thrown when rotateOptions is null.

Exception

save

public final void save(OutputStream document)
                throws Exception

Saves the result document to the stream document.

Parameters:

document - The document stream.

Throws:

NullPointerException - Thrown when document is null.

Exception

save

public final void save(String filePath)
                throws Exception

Saves the result document file to filePath.

Parameters:

filePath - The file name or full file path.

Throws:

NullPointerException - Thrown when filePath is null or empty.

Exception

save

public final void save(String filePath,
                       boolean useDefaultDirectory)
                throws Exception

Saves the result document file to filePath.

Parameters:

filePath - The file path or name in case of default directory usage.

useDefaultDirectory - Use the default directory from settings.

Throws:

NullPointerException - Thrown when filePath is null or empty.

Exception

split

public final void split(ISplitOptions splitOptions)
                 throws Exception

Splits the single document to the multiple documents.

Parameters:

splitOptions - The page split options.

Learn more

• More about document split scenarios and use cases: How to split PDF, Word, Excel and PowerPoint documents in 3 lines of code
• Quick guide about how to split text files in different ways: Split text files guide

Throws:

NullPointerException - Thrown when splitOptions is null.

Exception

split

public final void split(ITextSplitOptions splitOptions)
                 throws Exception

Splits the single document to the multiple documents.

Parameters:

splitOptions - The text split options.

Learn more

• More about document split scenarios and use cases: How to split PDF, Word, Excel and PowerPoint documents in 3 lines of code
• Quick guide about how to split text files in different ways: Split text files guide

Throws:

NullPointerException - Thrown when splitOptions is null.

Exception

swapPages

public final void swapPages(ISwapOptions swapOptions)
                     throws Exception

Swaps two pages within document of known format.

Parameters:

swapOptions - The swap options.

Learn more

• More about how to swap pages positions within document: How to swap pages inside PDF, Word, Excel or PowerPoint document

Throws:

NullPointerException - Thrown when swapOptions is null.

Exception

updatePassword

public final void updatePassword(IUpdatePasswordOptions updatePasswordOptions)
                          throws Exception

Updates existing password for document.

Parameters:

updatePasswordOptions - The options for specifying the current/new passwords.

Learn more

• More about how to protect document with password: How to protect PDF, Word, Excel and PowerPoint documents with password
• More about how to update or change document password: How to change document password
• More about how to check document password protected or not: How to check document password protection
• More about how to remove document password: How to remove PDF, Word, Excel and PowerPoint documents password

Throws:

NullPointerException - Thrown when updatePasswordOptions is null.

Exception