com.groupdocs.merger.domain.builders

Class PageBuilder

java.lang.Object

com.groupdocs.merger.domain.builders.PageBuilder

public class PageBuilder
extends Object

PageInfo builder for getting the page collection from the documents.

Constructor Summary

Constructors

Constructor and Description
PageBuilder() Initializes a new instance of the PageBuilder class.
PageBuilder(PageBuilderOptions options) Initializes a new instance of the PageBuilder class.

Method Summary

Modifier and Type	Method and Description
void	addDocument(DocumentInfo document) Add document to the document collection.
void	addDocument(int index, InputStream stream, FileType fileType, String password) Add document to the document collection.
void	addPage(int documentIndex, int pageNumber) Add page to the page collection.
void	addPage(IPageInfo page) Add page to the page collection.
void	addPageRange(IPageInfo[] pages) Add pages to the page collection.
void	clear() Clear the internal collections.
Map<Integer,DocumentInfo>	getDocuments() The document collection.
PageBuilderOptions	getOptions() The page builder options.
List<PageInfo>	getPages() The page collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageBuilder

public PageBuilder()

Initializes a new instance of the PageBuilder class.

PageBuilder

public PageBuilder(PageBuilderOptions options)

Initializes a new instance of the PageBuilder class.

Parameters:

options - The page builder options.

Throws:

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

Method Detail

addDocument

public final void addDocument(DocumentInfo document)

Add document to the document collection.

Parameters:

document - DocumentInfo instance.

addDocument

public final void addDocument(int index,
                              InputStream stream,
                              FileType fileType,
                              String password)

Add document to the document collection.

Parameters:

index - DocumentInfo index.

stream - DocumentInfo stream.

fileType - DocumentInfo type.

password - DocumentInfo password.

Throws:

com.aspose.ms.System.IndexOutOfRangeException

addPage

public final void addPage(int documentIndex,
                          int pageNumber)
                   throws Exception

Add page to the page collection.

Parameters:

documentIndex - DocumentInfo index.

pageNumber - PageInfo number.

Throws:

com.aspose.ms.System.IndexOutOfRangeException

Exception

addPage

public final void addPage(IPageInfo page)
                   throws Exception

Add page to the page collection.

Parameters:

page - PageInfo instance.

Throws:

com.aspose.ms.System.IndexOutOfRangeException

Exception

addPageRange

public final void addPageRange(IPageInfo[] pages)
                        throws Exception

Add pages to the page collection.

Parameters:

pages - Pages array.

Throws:

com.aspose.ms.System.IndexOutOfRangeException

Exception

clear

public final void clear()

Clear the internal collections.

getDocuments

public final Map<Integer,DocumentInfo> getDocuments()

The document collection.

getOptions

public final PageBuilderOptions getOptions()

The page builder options.

getPages

public final List<PageInfo> getPages()

The page collection.