com.adobe.platform.operation.pdfops

Class DeletePagesOperation

java.lang.Object

com.adobe.platform.operation.pdfops.DeletePagesOperation

All Implemented Interfaces:

Operation

public class DeletePagesOperation
extends Object
implements Operation

An operation to delete pages in a PDF file.

Sample Usage:

   DeletePagesOperation deletePagesOperation = DeletePagesOperation.createNew();
   deletePagesOperation.setInput(FileRef.createFromLocalFile("~/Documents/deletePagesOperationInput.pdf",
                                                             DeletePagesOperation.SupportedSourceFormat.PDF.getMediaType()));
   PageRanges pageRanges = new PageRanges();
   pageRanges.addSinglePage(1);
   deletePagesOperation.setPageRanges(pageRanges);
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdftools-api-credentials.json").build();
   FileRef result = deletePagesOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/deletePagesOperationOutput.pdf");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DeletePagesOperation	createNew() Constructs a DeletePagesOperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
void	setInput(FileRef sourceFileRef) Sets an input file.
void	setPageRanges(PageRanges pageRanges) Specifies the pages to delete from the input PDF file

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static DeletePagesOperation createNew()

Constructs a DeletePagesOperation instance.

Returns:

a new DeletePagesOperation 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)

Specifies the pages to delete from the input PDF file

Parameters:

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

execute

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

Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.

The resulting file 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:

the resulting PDF file

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