A B C D E F G H I O P S T V W

A

addAll() - Method in class com.adobe.platform.operation.pdfops.options.PageRanges

Adds a page range representing all pages.

addAllFrom(int) - Method in class com.adobe.platform.operation.pdfops.options.PageRanges

Adds a page range from start page index to the last page.

addInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.CombineFilesOperation

Specifies a PDF file (media type "application/pdf") to be combined with other files.

addInput(FileRef, PageRanges) - Method in class com.adobe.platform.operation.pdfops.CombineFilesOperation

Specifies particular pages of a PDF file (media type "application/pdf") to be combined with other files.

addRange(int, int) - Method in class com.adobe.platform.operation.pdfops.options.PageRanges

Adds a page range.

addSinglePage(int) - Method in class com.adobe.platform.operation.pdfops.options.PageRanges

Adds a single page.

Authentication - Class in com.adobe.platform.operation

Utility to initialize authentication.

B

build() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder

Returns a new CreatePDFFromHTMLOptions instance built from the current state of this builder.

Builder() - Constructor for class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder

Constructs a Builder instance.

C

ClientContext - Class in com.adobe.platform.operation

Represents the execution context of an Operation.

ClientContext() - Constructor for class com.adobe.platform.operation.ClientContext

com.adobe.platform.operation - package com.adobe.platform.operation

Contains the classes and sub-packages for various operations.

com.adobe.platform.operation.exception - package com.adobe.platform.operation.exception

Contains the classes for various exceptions that can be thrown by an Operation.

com.adobe.platform.operation.io - package com.adobe.platform.operation.io

Contains the classes for providing input or receiving the output of an Operation.

com.adobe.platform.operation.pdfops - package com.adobe.platform.operation.pdfops

Contains the classes for operations that generate or transform PDF files.

com.adobe.platform.operation.pdfops.options - package com.adobe.platform.operation.pdfops.options

Contains the option classes and sub-packages for Operation implementations in the com.adobe.platform.operation.pdfops package.

com.adobe.platform.operation.pdfops.options.createpdf - package com.adobe.platform.operation.pdfops.options.createpdf

Contains the option classes for CreatePDFOperation.

com.adobe.platform.operation.pdfops.options.exportpdf - package com.adobe.platform.operation.pdfops.options.exportpdf

Contains the option classes for ExportPDFOperation.

CombineFilesOperation - Class in com.adobe.platform.operation.pdfops

Combines multiple PDF files into a single PDF file.

create(String) - Static method in class com.adobe.platform.operation.Authentication

Creates an Authentication instance on the basis of auth credentials provided in JSON format.

createFromFile(String) - Static method in class com.adobe.platform.operation.ClientContext

Creates a context instance using the provided JSON config file path.

createFromLocalFile(String, String) - Static method in class com.adobe.platform.operation.io.FileRef

Creates a FileRef instance from a local file path with an explicitly specified media type.

createFromLocalFile(String) - Static method in class com.adobe.platform.operation.io.FileRef

Creates a FileRef instance from a local file path where the media type can be inferred from the file extension.

createFromStream(InputStream, String) - Static method in class com.adobe.platform.operation.io.FileRef

Creates a FileRef instance from an input stream using the specified media type.

createFromURL(URL, String) - Static method in class com.adobe.platform.operation.io.FileRef

Creates a FileRef instance from a URL.

createNew() - Static method in class com.adobe.platform.operation.pdfops.CombineFilesOperation

Constructs a CombineFilesOperation instance.

createNew() - Static method in class com.adobe.platform.operation.pdfops.CreatePDFOperation

Constructs a CreatePDFOperation instance.

createNew(ExportPDFTargetFormat) - Static method in class com.adobe.platform.operation.pdfops.ExportPDFOperation

Constructs a ExportPDFOperation instance.

CreatePDFFromHTMLOptions - Class in com.adobe.platform.operation.pdfops.options.createpdf

Parameters for converting HTML to PDF using CreatePDFOperation.

CreatePDFFromHTMLOptions.Builder - Class in com.adobe.platform.operation.pdfops.options.createpdf

Builds a CreatePDFFromHTMLOptions instance.

CreatePDFOperation - Class in com.adobe.platform.operation.pdfops

An Operation that converts a non-PDF file to a PDF file.

CreatePDFOperation.SupportedSourceFormat - Enum in com.adobe.platform.operation.pdfops

Supported source file formats for CreatePDFOperation.

CreatePDFOptions - Class in com.adobe.platform.operation.pdfops.options.createpdf

Marker base class for CreatePDFOperation options.

CreatePDFOptions() - Constructor for class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFOptions

D

DEFAULT_STATUS_CODE - Variable in exception com.adobe.platform.operation.exception.ServiceApiException

the default value of status code if there is no status code for this service failure.

E

execute(ClientContext) - Method in interface com.adobe.platform.operation.Operation

Executes this operation synchronously using the provided context instance.

execute(ClientContext) - Method in class com.adobe.platform.operation.pdfops.CombineFilesOperation

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

execute(ClientContext) - Method in class com.adobe.platform.operation.pdfops.CreatePDFOperation

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

execute(ClientContext) - Method in class com.adobe.platform.operation.pdfops.ExportPDFOperation

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

ExportPDFOperation - Class in com.adobe.platform.operation.pdfops

An Operation which exports a source PDF file to a supported format specified by ExportPDFTargetFormat.

ExportPDFTargetFormat - Enum in com.adobe.platform.operation.pdfops.options.exportpdf

Supported target formats for ExportPDFOperation

F

FileRef - Class in com.adobe.platform.operation.io

This class represents either a local file or a URL-based web page.

FileRef() - Constructor for class com.adobe.platform.operation.io.FileRef

G

getFileExt() - Method in enum com.adobe.platform.operation.pdfops.options.exportpdf.ExportPDFTargetFormat

Returns the file extension of this format

getMediaType() - Method in enum com.adobe.platform.operation.pdfops.CreatePDFOperation.SupportedSourceFormat

Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.

getMessage() - Method in exception com.adobe.platform.operation.exception.ServiceApiException

Returns the detail message of this exception.

getPageHeight() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.PageLayout

Returns the page height in inches.

getPageLayout() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions

Returns the intended page layout of the resulting PDF file.

getPageWidth() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.PageLayout

Returns the page width in inches.

getRequestTrackingId() - Method in exception com.adobe.platform.operation.exception.ServiceApiException

Returns the Request ID (the value of the X-Request-ID header).

getStatusCode() - Method in exception com.adobe.platform.operation.exception.ServiceApiException

Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.

H

htmlOptionsBuilder() - Static method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFOptions

Creates a new CreatePDFFromHTMLOptions builder.

I

includeHeaderFooter(boolean) - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder

Sets the includeHeaderFooter parameter.

includesHeaderFooter() - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions

Returns true if default header and footer will be included in the resulting PDF file.

O

Operation - Interface in com.adobe.platform.operation

This interface represents the basic contract for all the Operations.

P

PageLayout - Class in com.adobe.platform.operation.pdfops.options.createpdf

Class for specifying the layout of a page.

PageLayout() - Constructor for class com.adobe.platform.operation.pdfops.options.createpdf.PageLayout

Constructor to initialize a default page layout.

PageRanges - Class in com.adobe.platform.operation.pdfops.options

Page ranges of a file, inclusive of start and end page index, where page index starts from 1.

PageRanges() - Constructor for class com.adobe.platform.operation.pdfops.options.PageRanges

Constructs a new PageRanges instance with no pages added.

S

saveAs(String) - Method in class com.adobe.platform.operation.io.FileRef

Saves this file to the location specified by targetLocation.

saveAs(OutputStream) - Method in class com.adobe.platform.operation.io.FileRef

Writes the contents of this file to outputStream.

SdkException - Exception in com.adobe.platform.operation.exception

SdkException is typically thrown for client-side or network errors.

SdkException(String, Throwable) - Constructor for exception com.adobe.platform.operation.exception.SdkException

Creates an SdkException with the specified detail message and cause.

SdkException(String) - Constructor for exception com.adobe.platform.operation.exception.SdkException

Constructs an SdkException with the specified detail message.

ServiceApiException - Exception in com.adobe.platform.operation.exception

ServiceApiException is thrown when an underlying service API call results in an error.

ServiceApiException(String) - Constructor for exception com.adobe.platform.operation.exception.ServiceApiException

Constructs a ServiceApiException with the specified detail message.

ServiceApiException(String, String, int) - Constructor for exception com.adobe.platform.operation.exception.ServiceApiException

Constructs a ServiceApiException with the specified detail message, requestId and returned HTTP status code.

setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.CreatePDFOperation

Sets an input file.

setInput(FileRef) - Method in class com.adobe.platform.operation.pdfops.ExportPDFOperation

Sets an input PDF file (media type "application/pdf").

setOptions(CreatePDFOptions) - Method in class com.adobe.platform.operation.pdfops.CreatePDFOperation

Sets the conversion parameters for this operation.

setPageSize(double, double) - Method in class com.adobe.platform.operation.pdfops.options.createpdf.PageLayout

Sets a custom page size.

T

toString() - Method in class com.adobe.platform.operation.pdfops.options.PageRanges

Used internally by this SDK, not intended to be called by clients.

V

validate() - Method in class com.adobe.platform.operation.pdfops.options.PageRanges

Used internally by this SDK, not intended to be called by clients.

valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.CreatePDFOperation.SupportedSourceFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.options.exportpdf.ExportPDFTargetFormat

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.adobe.platform.operation.pdfops.CreatePDFOperation.SupportedSourceFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.adobe.platform.operation.pdfops.options.exportpdf.ExportPDFTargetFormat

Returns an array containing the constants of this enum type, in the order they are declared.

W

withAuthentication(Authentication) - Method in class com.adobe.platform.operation.ClientContext

Creates a copy of this ClientContext with the provided Authentication instance.

withPageLayout(PageLayout) - Method in class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder

Sets the pageLayout parameter.

A B C D E F G H I O P S T V W