com.adobe.platform.operation.pdfops

Class RotatePagesOperation

java.lang.Object

com.adobe.platform.operation.pdfops.RotatePagesOperation

All Implemented Interfaces:

Operation

public class RotatePagesOperation
extends Object
implements Operation

An operation that allows rotation of specific pages in a PDF file.

Sample Usage:

   RotatePagesOperation rotatePagesOperation = RotatePagesOperation.createNew();
   rotatePagesOperation.setInput(FileRef.createFromLocalFile("~/Documents/rotatePagesOperationInput.pdf",
                                                             RotatePagesOperation.SupportedSourceFormat.PDF.getMediaType()));
   rotatePagesOperation.setAngleToRotatePagesBy(Angle._90);
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdftools-api-credentials.json").build();
   FileRef result = rotatePagesOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/rotatePagesOperationOutput.pdf");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RotatePagesOperation	createNew() Constructs a RotatePagesOperation 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	setAngleToRotatePagesBy(Angle angle) Sets angle (in clockwise direction) for rotating all the pages of the input PDF file.
void	setAngleToRotatePagesBy(Angle angle, PageRanges pageRanges) Sets angle (in clockwise direction) for rotating the specified pages of the input PDF file; can be invoked multiple times to set rotation for different set of page ranges.
void	setInput(FileRef sourceFileRef) Sets an input file.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static RotatePagesOperation createNew()

Constructs a RotatePagesOperation instance.

Returns:

a new RotatePagesOperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file; can not be null

setAngleToRotatePagesBy

public void setAngleToRotatePagesBy(Angle angle)

Sets angle (in clockwise direction) for rotating all the pages of the input PDF file.

Multiple invocations of this method will result in rotating the pages multiple times.

Parameters:

angle - angle for rotation; see Angle for valid angle values

setAngleToRotatePagesBy

public void setAngleToRotatePagesBy(Angle angle,
                                    PageRanges pageRanges)

Sets angle (in clockwise direction) for rotating the specified pages of the input PDF file; can be invoked multiple times to set rotation for different set of page ranges.

Multiple invocations of this method on the same set of pages can result in rotating the pages multiple times.

 For e.g.:
 PageRanges pageRanges = new PageRanges();
 pageRanges.addSinglePage(1);
 rotatePagesOperation.setAngleToRotatePagesBy(Angle._90, pageRanges);
 rotatePagesOperation.setAngleToRotatePagesBy(Angle._180, pageRanges);
 

Above invocations will effectively rotate pages (as specified by the page ranges) by 270 degrees.

Parameters:

angle - angle for rotation; see Angle for valid angle values

pageRanges - page ranges for rotation; 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