com.adobe.pdfservices.operation.pdfops

Class SplitPDFOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.SplitPDFOperation

All Implemented Interfaces:

Operation

public class SplitPDFOperation
extends Object
implements Operation

An operation that splits PDF document into multiple smaller documents by simply specifying either the number of files, pages per file, or page ranges.

Sample Usage:

   SplitPDFOperation splitPDFOperation = SplitPDFOperation.createNew();
   splitPDFOperation.setInput(FileRef.createFromLocalFile("~/Documents/splitPDFOperationInput.pdf",
                                                             SplitPDFOperation.SupportedSourceFormat.PDF.getMediaType()));
   splitPDFOperation.setPageCount(2);
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdfservices-api-credentials.json").build();
   List<FileRef> result = splitPDFOperation.execute(ExecutionContext.create(credentials));
   int index = 0;
   for (FileRef fileRef : result) {
      fileRef.saveAs("output/splitPDFOperationOutput_" + index + ".pdf");
      index++;
   }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SplitPDFOperation.SupportedSourceFormat Supported source file formats for SplitPDFOperation.

Method Summary

Modifier and Type	Method and Description
static SplitPDFOperation	createNew() Constructs a SplitPDFOperation instance.
List<FileRef>	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new list of FileRef instances for the resultant PDF files.
void	setFileCount(int fileCount) Sets the number of documents to split the input PDF.
void	setInput(FileRef sourceFileRef) Sets an input file.
void	setPageCount(int pageCount) Sets the maximum number of pages each of the output files can have.
void	setPageRanges(PageRanges pageRanges) Sets the page ranges on the basis of which to split the input PDF file.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static SplitPDFOperation createNew()

Constructs a SplitPDFOperation instance.

Returns:

a new SplitPDFOperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file; can not be null

setPageRanges

public void setPageRanges(PageRanges pageRanges)

Sets the page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range.

Parameters:

pageRanges - page ranges for split; can not be null or empty

setPageCount

public void setPageCount(int pageCount)

Sets the maximum number of pages each of the output files can have.

Parameters:

pageCount - maximum number of pages per output file

setFileCount

public void setFileCount(int fileCount)

Sets the number of documents to split the input PDF.

Parameters:

fileCount - represents the number of output files

execute

public List<FileRef> execute(ExecutionContext context)
                      throws ServiceApiException,
                             IOException,
                             ServiceUsageException

Executes this operation synchronously using the supplied context and returns a new list of FileRef instances for the resultant PDF files.

The resultant files may be stored in the system temporary directory (per java.io.tmpdir System property). See FileRef for how temporary resources are cleaned up.

Specified by:

execute in interface Operation

Parameters:

context - the context in which to execute the operation

Returns:

list of resultant PDF files

Throws:

ServiceApiException - if an API call results in an error response

IOException - if there is an error in reading either the input source or the resulting PDF file

ServiceUsageException - if service usage limits have been reached or credentials quota has been exhausted