A B C D E F G H I J L M N O P R S T U V W X

A

AbstractConversionJob - Class in org.jodconverter.job

Base class for all conversion job implementations.

AbstractConversionJob(AbstractSourceDocumentSpecs, AbstractTargetDocumentSpecs) - Constructor for class org.jodconverter.job.AbstractConversionJob

AbstractConversionJobWithSourceFormatUnspecified - Class in org.jodconverter.job

Base class for all conversion job implementations with source format that is not yet applied to the converter.

AbstractConversionJobWithSourceFormatUnspecified(AbstractSourceDocumentSpecs, OfficeManager, DocumentFormatRegistry) - Constructor for class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

AbstractConverter - Class in org.jodconverter.job

Base class for all document converter implementations.

AbstractConverter(OfficeManager, DocumentFormatRegistry) - Constructor for class org.jodconverter.job.AbstractConverter

AbstractConverter.AbstractConverterBuilder<B extends AbstractConverter.AbstractConverterBuilder<B>> - Class in org.jodconverter.job

A builder for constructing an AbstractConverter.

AbstractConverterBuilder() - Constructor for class org.jodconverter.job.AbstractConverter.AbstractConverterBuilder

AbstractDocumentSpecs - Class in org.jodconverter.job

Base class for all document specifications implementations.

AbstractDocumentSpecs(File) - Constructor for class org.jodconverter.job.AbstractDocumentSpecs

AbstractOfficeTask - Class in org.jodconverter.task

Base class for all office tasks implementation.

AbstractOfficeTask(SourceDocumentSpecs) - Constructor for class org.jodconverter.task.AbstractOfficeTask

Creates a new task with the specified source document.

AbstractSourceDocumentSpecs - Class in org.jodconverter.job

Base class for all source document specifications implementations.

AbstractSourceDocumentSpecs(File) - Constructor for class org.jodconverter.job.AbstractSourceDocumentSpecs

AbstractTargetDocumentSpecs - Class in org.jodconverter.job

Base class for all target document specifications implementations.

AbstractTargetDocumentSpecs(File) - Constructor for class org.jodconverter.job.AbstractTargetDocumentSpecs

addFormat(DocumentFormat) - Method in class org.jodconverter.document.SimpleDocumentFormatRegistry

Add a new format to the registry.

as(DocumentFormat) - Method in class org.jodconverter.job.AbstractConversionJob

as(DocumentFormat) - Method in class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

as(DocumentFormat) - Method in interface org.jodconverter.job.ConversionJobWithRequiredSourceFormatUnspecified

Defines the source document format for the given input document.

as(DocumentFormat) - Method in interface org.jodconverter.job.ConversionJobWithRequiredTargetFormatUnspecified

Defines the target document format for the given input document.

B

BMP - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Windows Bitmap.

build() - Method in class org.jodconverter.document.DocumentFormat.Builder

Creates the converter that is specified by this builder.

build() - Method in class org.jodconverter.job.AbstractConverter.AbstractConverterBuilder

Creates the converter that is specified by this builder.

builder() - Static method in class org.jodconverter.document.DocumentFormat

Creates a new builder instance.

C

ConversionJob - Interface in org.jodconverter.job

A fully specified conversion that is not yet applied to the converter.

ConversionJobWithOptionalSourceFormatUnspecified - Interface in org.jodconverter.job

A conversion job with optional source format that is not yet applied to the converter.

ConversionJobWithOptionalTargetFormatUnspecified - Interface in org.jodconverter.job

A conversion job with optional target format that is not yet applied to the converter.

ConversionJobWithRequiredSourceFormatUnspecified - Interface in org.jodconverter.job

A conversion job with required source format that is not yet applied to the converter.

ConversionJobWithRequiredTargetFormatUnspecified - Interface in org.jodconverter.job

A conversion job with required target format that is not yet applied to the converter.

ConversionJobWithSourceSpecified - Interface in org.jodconverter.job

A conversion job with a specified source for the conversion.

convert(File) - Method in interface org.jodconverter.DocumentConverter

Converts a source file that is stored on the local file system.

convert(InputStream) - Method in interface org.jodconverter.DocumentConverter

Converts a source stream input stream.

convert(InputStream, boolean) - Method in interface org.jodconverter.DocumentConverter

Converts a source stream input stream.

convert(File) - Method in class org.jodconverter.job.AbstractConverter

convert(InputStream) - Method in class org.jodconverter.job.AbstractConverter

convert(InputStream, boolean) - Method in class org.jodconverter.job.AbstractConverter

convert(AbstractSourceDocumentSpecs) - Method in class org.jodconverter.job.AbstractConverter

Converts a source document using the given specifications.

copy(DocumentFormat) - Static method in class org.jodconverter.document.DocumentFormat

Creates a new modifiable DocumentFormat from the specified format.

create(InputStream) - Static method in class org.jodconverter.document.JsonDocumentFormatRegistry

Creates a JsonDocumentFormatRegistry from the given InputStream.

create(InputStream, Map<String, DocumentFormatProperties>) - Static method in class org.jodconverter.document.JsonDocumentFormatRegistry

Creates a JsonDocumentFormatRegistry from the given InputStream.

create(String) - Static method in class org.jodconverter.document.JsonDocumentFormatRegistry

Creates a JsonDocumentFormatRegistry from the given source.

create(String, Map<String, DocumentFormatProperties>) - Static method in class org.jodconverter.document.JsonDocumentFormatRegistry

Creates a JsonDocumentFormatRegistry from the given source.

CSV - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Comma Separated Values.

D

DefaultDocumentFormatRegistry - Class in org.jodconverter.document

Default DocumentFormat registry.

DefaultDocumentFormatRegistryInstanceHolder - Class in org.jodconverter.document

Holds the default DocumentFormatRegistry instance.

DOC - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Microsoft Word 97-2003.

DocumentConverter - Interface in org.jodconverter

A DocumentConverter is responsible to execute the conversion of documents using an office manager.

DocumentFamily - Enum in org.jodconverter.document

Represents a document type supported by office.

DocumentFormat - Class in org.jodconverter.document

Contains the required information used to deal with a specific document format .

DocumentFormat.Builder - Class in org.jodconverter.document

A builder for constructing a DocumentFormat.

DocumentFormatProperties - Class in org.jodconverter.document

Contains properties that will be applied when loading(opening) and storing(saving) document for a specific DocumentFormat.

DocumentFormatProperties() - Constructor for class org.jodconverter.document.DocumentFormatProperties

DocumentFormatRegistry - Interface in org.jodconverter.document

A class implementing this interface should keep a collection of document format supported by office.

DocumentFormatRegistryException - Exception in org.jodconverter.document

Exception thrown when a DefaultDocumentFormatRegistry cannot be created and initialized properly.

DocumentFormatRegistryException(String, Throwable) - Constructor for exception org.jodconverter.document.DocumentFormatRegistryException

Constructs an exception with the specified detail message and cause.

DocumentSpecsIOException - Exception in org.jodconverter.job

Wraps an IOException with an unchecked exception while performing IO operations on a DocumentSpecs implementation.

DocumentSpecsIOException(String, Throwable) - Constructor for exception org.jodconverter.job.DocumentSpecsIOException

Constructs a exception with the specified detail message and cause.

DOCX - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Microsoft Word 2007-2013 XML.

doExecute() - Method in class org.jodconverter.job.AbstractConversionJob

Executes the conversion and blocks until the conversion terminates.

E

execute() - Method in class org.jodconverter.job.AbstractConversionJob

execute() - Method in interface org.jodconverter.job.ConversionJob

Executes a conversion and blocks until the conversion terminates.

execute(OfficeTask) - Method in interface org.jodconverter.office.OfficeManager

Executes the specified task and blocks until the task terminates.

execute(OfficeContext) - Method in interface org.jodconverter.task.OfficeTask

Executes the task in the specified context.

extension(String) - Method in class org.jodconverter.document.DocumentFormat.Builder

Specifies the extension associated with the document format.

F

FODG - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Drawing Flat XML.

FODP - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Presentation Flat XML.

FODS - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Spreadsheet Flat XML.

FODT - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Text Flat XML.

formatRegistry - Variable in class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

formatRegistry - Variable in class org.jodconverter.job.AbstractConverter.AbstractConverterBuilder

formatRegistry(DocumentFormatRegistry) - Method in class org.jodconverter.job.AbstractConverter.AbstractConverterBuilder

Specifies the DocumentFormatRegistry which contains the document formats that will be supported by this converter.

formatRegistry - Variable in class org.jodconverter.job.AbstractConverter

from(DocumentFormat) - Method in class org.jodconverter.document.DocumentFormat.Builder

Initializes the builder by copying the properties of the specified document format.

G

getExtension() - Method in class org.jodconverter.document.DocumentFormat

Gets the extension associated with the document format.

getExtensions() - Method in class org.jodconverter.document.DocumentFormat

Gets the file name extensions of the document format.

getFile() - Method in class org.jodconverter.job.AbstractDocumentSpecs

getFormat() - Method in class org.jodconverter.job.AbstractDocumentSpecs

getFormatByExtension(String) - Static method in class org.jodconverter.document.DefaultDocumentFormatRegistry

Gets a document format for the specified extension.

getFormatByExtension(String) - Method in interface org.jodconverter.document.DocumentFormatRegistry

Gets a document format for the specified extension.

getFormatByExtension(String) - Method in class org.jodconverter.document.SimpleDocumentFormatRegistry

getFormatByMediaType(String) - Static method in class org.jodconverter.document.DefaultDocumentFormatRegistry

Gets a document format for the specified media type.

getFormatByMediaType(String) - Method in interface org.jodconverter.document.DocumentFormatRegistry

Gets a document format for the specified media type.

getFormatByMediaType(String) - Method in class org.jodconverter.document.SimpleDocumentFormatRegistry

getFormatRegistry() - Method in interface org.jodconverter.DocumentConverter

Gets all the DocumentFormat supported by the converter.

getFormatRegistry() - Method in class org.jodconverter.job.AbstractConverter

getInputFamily() - Method in class org.jodconverter.document.DocumentFormat

Gets the input DocumentFamily of the document format.

getInstance() - Static method in class org.jodconverter.document.DefaultDocumentFormatRegistry

Gets the default instance of the class.

getInstance() - Static method in class org.jodconverter.document.DefaultDocumentFormatRegistryInstanceHolder

Gets the default DocumentFormatRegistry instance.

getInstance() - Static method in class org.jodconverter.office.InstalledOfficeManagerHolder

Gets the static instance of the static holder class.

getLoad() - Method in class org.jodconverter.document.DocumentFormatProperties

getLoadProperties() - Method in class org.jodconverter.document.DocumentFormat

Gets the properties required to load(open) a document of this format.

getMediaType() - Method in class org.jodconverter.document.DocumentFormat

Gets the media (mime) type of the format.

getName() - Method in class org.jodconverter.document.DocumentFormat

Gets the name of the format.

getOutputFormats(DocumentFamily) - Static method in class org.jodconverter.document.DefaultDocumentFormatRegistry

Gets all the DocumentFormats of a given family.

getOutputFormats(DocumentFamily) - Method in interface org.jodconverter.document.DocumentFormatRegistry

Gets all the DocumentFormats of a given family.

getOutputFormats(DocumentFamily) - Method in class org.jodconverter.document.SimpleDocumentFormatRegistry

getStore() - Method in class org.jodconverter.document.DocumentFormatProperties

getStoreProperties() - Method in class org.jodconverter.document.DocumentFormat

Gets the properties required to store(save) a document of this format to a document of supported families.

getStoreProperties(DocumentFamily) - Method in class org.jodconverter.document.DocumentFormat

Gets the properties required to store(save) a document to this format from a document of the specified family.

GIF - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Graphic Interchange Format.

H

HTML - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

HTML.

I

inputFamily(DocumentFamily) - Method in class org.jodconverter.document.DocumentFormat.Builder

Specifies the input (when a document is loaded) DocumentFamily associated with the document format.

InstalledOfficeManagerHolder - Class in org.jodconverter.office

Holds a unique instance of an OfficeManager that will be used by created DocumentConverter when no office manager are given to the converter builder.

isRunning() - Method in interface org.jodconverter.office.OfficeManager

Gets whether the manager is running.

J

JPEG - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Joint Photographic Experts Group.

JsonDocumentFormatRegistry - Class in org.jodconverter.document

A JsonDocumentFormatRegistry contains a collection of DocumentFormat supported by office that has been loaded loaded from a JSON source.

JsonDocumentFormatRegistry() - Constructor for class org.jodconverter.document.JsonDocumentFormatRegistry

L

loadProperty(String, Object) - Method in class org.jodconverter.document.DocumentFormat.Builder

Adds a property to the builder that will be applied when loading (open) a document of this format.

M

makeTemporaryFile() - Method in interface org.jodconverter.office.TemporaryFileMaker

Creates a new temporary file without an extension.

makeTemporaryFile(String) - Method in interface org.jodconverter.office.TemporaryFileMaker

Creates a new temporary file with the specified extension.

mediaType(String) - Method in class org.jodconverter.document.DocumentFormat.Builder

Specifies the media (mime) type of the document format.

N

name(String) - Method in class org.jodconverter.document.DocumentFormat.Builder

Specifies the name of the document format.

O

ODG - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Drawing.

ODP - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Presentation.

ODS - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Spreadsheet.

ODT - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Text.

OfficeContext - Interface in org.jodconverter.office

Base interface for all office context interfaces.

OfficeException - Exception in org.jodconverter.office

An exception that provides information on an error while dealing with office.

OfficeException(String) - Constructor for exception org.jodconverter.office.OfficeException

Constructs a new office exception with the specified detail message.

OfficeException(String, Throwable) - Constructor for exception org.jodconverter.office.OfficeException

Constructs a new office exception with the specified detail message and cause.

officeManager - Variable in class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

officeManager - Variable in class org.jodconverter.job.AbstractConverter.AbstractConverterBuilder

officeManager(OfficeManager) - Method in class org.jodconverter.job.AbstractConverter.AbstractConverterBuilder

Specifies the OfficeManager the converter will use to execute office tasks.

officeManager - Variable in class org.jodconverter.job.AbstractConverter

OfficeManager - Interface in org.jodconverter.office

An office manager knows how to execute an OfficeTask.

OfficeTask - Interface in org.jodconverter.task

Represents a task executed by an OfficeManager.

OfficeUtils - Class in org.jodconverter.office

Provides helper functions for office.

onComplete(File) - Method in interface org.jodconverter.job.TargetDocumentSpecs

Called if the conversion was completed successfully.

onConsumed(File) - Method in interface org.jodconverter.job.SourceDocumentSpecs

Called when the file was consumed and is not longer required by the converter.

onFailure(File, Exception) - Method in interface org.jodconverter.job.TargetDocumentSpecs

Called if the conversion finished with an exception.

org.jodconverter - package org.jodconverter

This package contains the interfaces/classes related to the tasks an office process can execute.

org.jodconverter.document - package org.jodconverter.document

This package contains the DocumentFormat class that contains the information required by JODConverter to convert from/to specific document formats.

org.jodconverter.job - package org.jodconverter.job

This package contains the interfaces/classes used by the DocumentConverter converter implementation that offers a fluent API to execute document conversions.

org.jodconverter.office - package org.jodconverter.office

This package contains the interfaces/classes related to the management of the office processes launched by JODConverter.

org.jodconverter.task - package org.jodconverter.task

This package provides the classes that can be used to convert a document from a specific format to another format.

OTG - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Drawing Template.

OTP - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Presentation Template.

OTS - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Spreadsheet Template.

OTT - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenDocument Text Template.

P

PDF - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Portable Document Format.

PNG - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Portable Network Graphics.

PPT - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Microsoft PowerPoint 97-2003.

PPTX - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Microsoft PowerPoint 2007-2013 XML.

R

readJsonArray(String, Map<String, DocumentFormatProperties>) - Method in class org.jodconverter.document.JsonDocumentFormatRegistry

RTF - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Rich Text Format.

S

setInstance(DocumentFormatRegistry) - Static method in class org.jodconverter.document.DefaultDocumentFormatRegistryInstanceHolder

Sets the default DocumentFormatRegistry instance.

setInstance(OfficeManager) - Static method in class org.jodconverter.office.InstalledOfficeManagerHolder

Sets the static instance of the static holder class.

SimpleDocumentFormatRegistry - Class in org.jodconverter.document

A SimpleDocumentFormatRegistry contains a collection of document formats supported by office.

SimpleDocumentFormatRegistry() - Constructor for class org.jodconverter.document.SimpleDocumentFormatRegistry

source - Variable in class org.jodconverter.job.AbstractConversionJob

source - Variable in class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

source - Variable in class org.jodconverter.task.AbstractOfficeTask

SourceDocumentSpecs - Interface in org.jodconverter.job

An interface that provides the behavior to apply when a source file is no longer required by a conversion process.

start() - Method in interface org.jodconverter.office.OfficeManager

Starts the manager.

stop() - Method in interface org.jodconverter.office.OfficeManager

Stops the manager.

stopQuietly(OfficeManager) - Static method in class org.jodconverter.office.OfficeUtils

Stops an OfficeManager unconditionally.

storeProperty(DocumentFamily, String, Object) - Method in class org.jodconverter.document.DocumentFormat.Builder

Adds a property to the builder that will be applied when storing (save) a document to this format from a document of the specified family.

SVG - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Scalable Vector Graphics.

SWF - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Macromedia Flash.

SXC - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenOffice.org 1.0 Spreadsheet.

SXI - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenOffice.org 1.0 Presentation.

SXW - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

OpenOffice.org 1.0 Text Document.

T

target - Variable in class org.jodconverter.job.AbstractConversionJob

TargetDocumentSpecs - Interface in org.jodconverter.job

An interface that provides the behavior to apply when a target file is no longer required by a conversion process.

TemporaryFileMaker - Interface in org.jodconverter.office

Provides services to create temporary files.

TIFF - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Tagged Image File Format.

to(File) - Method in class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

to(OutputStream) - Method in class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

to(OutputStream, boolean) - Method in class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

to(AbstractTargetDocumentSpecs) - Method in class org.jodconverter.job.AbstractConversionJobWithSourceFormatUnspecified

Configures the current conversion to write the result using the specified specifications.

to(File) - Method in interface org.jodconverter.job.ConversionJobWithSourceSpecified

Configures the current conversion to write the result to the specified target.

to(OutputStream) - Method in interface org.jodconverter.job.ConversionJobWithSourceSpecified

Configures the current conversion to write the result to the specified OutputStream.

to(OutputStream, boolean) - Method in interface org.jodconverter.job.ConversionJobWithSourceSpecified

Configures the current conversion to write the result to the specified OutputStream.

toString() - Method in class org.jodconverter.document.DocumentFormat

TSV - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Tab Separated Values.

TXT - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Plain Text.

U

unmodifiable(boolean) - Method in class org.jodconverter.document.DocumentFormat.Builder

Specifies whether the document format is unmodifiable after creation.

unmodifiableCopy(DocumentFormat) - Static method in class org.jodconverter.document.DocumentFormat

Creates a new unmodifiable DocumentFormat from the specified format.

V

valueOf(String) - Static method in enum org.jodconverter.document.DocumentFamily

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

values() - Static method in enum org.jodconverter.document.DocumentFamily

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

W

WPD - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

WordPerfect.

X

XLS - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Microsoft Excel 97-2003.

XLSX - Static variable in class org.jodconverter.document.DefaultDocumentFormatRegistry

Microsoft Excel 2007-2013 XML.

A B C D E F G H I J L M N O P R S T U V W X