Skip navigation links
JODConverter Core 4.4.5 API
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.core.job
Base class for all conversion job implementations.
AbstractConversionJob(AbstractSourceDocumentSpecs, AbstractTargetDocumentSpecs) - Constructor for class org.jodconverter.core.job.AbstractConversionJob
 
AbstractConversionJobWithSourceFormatUnspecified - Class in org.jodconverter.core.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.core.job.AbstractConversionJobWithSourceFormatUnspecified
 
AbstractConverter - Class in org.jodconverter.core.job
Base class for all document converter implementations.
AbstractConverter(OfficeManager, DocumentFormatRegistry) - Constructor for class org.jodconverter.core.job.AbstractConverter
 
AbstractConverter.AbstractConverterBuilder<B extends AbstractConverter.AbstractConverterBuilder<B>> - Class in org.jodconverter.core.job
A builder for constructing an AbstractConverter.
AbstractConverterBuilder() - Constructor for class org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder
 
AbstractDocumentSpecs - Class in org.jodconverter.core.job
Base class for all document specifications implementations.
AbstractDocumentSpecs() - Constructor for class org.jodconverter.core.job.AbstractDocumentSpecs
 
AbstractDocumentSpecs(File) - Constructor for class org.jodconverter.core.job.AbstractDocumentSpecs
 
AbstractOfficeManagerPool<E extends AbstractOfficeManagerPoolEntry> - Class in org.jodconverter.core.office
An AbstractOfficeManagerPool is responsible to maintain a pool of AbstractOfficeManagerPoolEntry that will be used to execute OfficeTask.
AbstractOfficeManagerPool(int, File, long) - Constructor for class org.jodconverter.core.office.AbstractOfficeManagerPool
Constructs a new instance of the class with the specified settings.
AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B extends AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B>> - Class in org.jodconverter.core.office
A builder for constructing an AbstractOfficeManagerPool.
AbstractOfficeManagerPoolBuilder() - Constructor for class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
 
AbstractOfficeManagerPoolEntry - Class in org.jodconverter.core.office
Base class for all office manager pool entry implementations.
AbstractOfficeManagerPoolEntry(long) - Constructor for class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
Initializes a new pool entry with the specified configuration.
AbstractOfficeTask - Class in org.jodconverter.core.task
Base class for all office tasks implementation.
AbstractOfficeTask(SourceDocumentSpecs) - Constructor for class org.jodconverter.core.task.AbstractOfficeTask
Creates a new task with the specified source document.
AbstractRetryable<T extends Throwable> - Class in org.jodconverter.core.office
Object that will attempt to execute a task until it succeeds or that a specific timeout is reached.
AbstractRetryable() - Constructor for class org.jodconverter.core.office.AbstractRetryable
Initializes a new instance of the class.
AbstractSourceDocumentSpecs - Class in org.jodconverter.core.job
Base class for all source document specifications implementations.
AbstractSourceDocumentSpecs() - Constructor for class org.jodconverter.core.job.AbstractSourceDocumentSpecs
 
AbstractSourceDocumentSpecs(File) - Constructor for class org.jodconverter.core.job.AbstractSourceDocumentSpecs
 
AbstractTargetDocumentSpecs - Class in org.jodconverter.core.job
Base class for all target document specifications implementations.
AbstractTargetDocumentSpecs() - Constructor for class org.jodconverter.core.job.AbstractTargetDocumentSpecs
 
AbstractTargetDocumentSpecs(File) - Constructor for class org.jodconverter.core.job.AbstractTargetDocumentSpecs
 
addFormat(DocumentFormat) - Method in class org.jodconverter.core.document.SimpleDocumentFormatRegistry
Add a new format to the registry.
appendIfMissing(String, String) - Static method in class org.jodconverter.core.util.StringUtils
Appends the suffix to the end of the string if the string does not already end with the suffix.
as(DocumentFormat) - Method in class org.jodconverter.core.job.AbstractConversionJob
 
as(DocumentFormat) - Method in class org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified
 
as(DocumentFormat) - Method in interface org.jodconverter.core.job.ConversionJobWithOptionalSourceFormatUnspecified
Defines the source document format for the given input document.
as(DocumentFormat) - Method in interface org.jodconverter.core.job.ConversionJobWithRequiredTargetFormatUnspecified
Defines the target document format for the given input document.
AssertUtils - Class in org.jodconverter.core.util
Contains assertions helper functions.
attempt() - Method in class org.jodconverter.core.office.AbstractRetryable
Attempt to execute the task, once.

B

beforeExecute(Thread, Runnable) - Method in class org.jodconverter.core.office.SuspendableThreadPoolExecutor
 
BMP - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Windows Bitmap.
build() - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Creates the converter that is specified by this builder.
build() - Method in class org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder
Creates the converter that is specified by this builder.
build() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
Creates the manager that is specified by this builder.
builder() - Static method in class org.jodconverter.core.document.DocumentFormat
Creates a new builder instance.
builder(DocumentFormat) - Static method in class org.jodconverter.core.document.DocumentFormat
Creates a new builder instance from the specified format.

C

cancelTask() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
Cancels the current running task, if any.
ConversionJob - Interface in org.jodconverter.core.job
A fully specified conversion that is not yet applied to the converter.
ConversionJobWithOptionalSourceFormatUnspecified - Interface in org.jodconverter.core.job
A conversion job with optional source format that is not yet applied to the converter.
ConversionJobWithOptionalTargetFormatUnspecified - Interface in org.jodconverter.core.job
A conversion job with optional target format that is not yet applied to the converter.
ConversionJobWithRequiredTargetFormatUnspecified - Interface in org.jodconverter.core.job
A conversion job with required target format that is not yet applied to the converter.
ConversionJobWithSourceSpecified - Interface in org.jodconverter.core.job
A conversion job with a specified source for the conversion.
convert(File) - Method in interface org.jodconverter.core.DocumentConverter
Converts a source file that is stored on the local file system.
convert(InputStream) - Method in interface org.jodconverter.core.DocumentConverter
Converts a source stream input stream.
convert(InputStream, boolean) - Method in interface org.jodconverter.core.DocumentConverter
Converts a source stream input stream.
convert(File) - Method in class org.jodconverter.core.job.AbstractConverter
 
convert(InputStream) - Method in class org.jodconverter.core.job.AbstractConverter
 
convert(InputStream, boolean) - Method in class org.jodconverter.core.job.AbstractConverter
 
convert(AbstractSourceDocumentSpecs) - Method in class org.jodconverter.core.job.AbstractConverter
Converts a source document using the given specifications.
copy(DocumentFormat) - Static method in class org.jodconverter.core.document.DocumentFormat
Creates a new modifiable DocumentFormat from the specified format.
copy(InputStream, OutputStream) - Static method in class org.jodconverter.core.util.IOUtils
Reads all bytes from an input stream and writes them to an output stream.
copyDirectory(File, File, CopyOption...) - Static method in class org.jodconverter.core.util.FileUtils
Copies a directory recursively, preserving the files last modified date.
copyFile(File, File, CopyOption...) - Static method in class org.jodconverter.core.util.FileUtils
Copies a file to another path, preserving the last modified date.
copyFileToDirectory(File, File, CopyOption...) - Static method in class org.jodconverter.core.util.FileUtils
Copies a file to a directory, preserving the last modified date.
create(InputStream) - Static method in class org.jodconverter.core.document.JsonDocumentFormatRegistry
Creates a JsonDocumentFormatRegistry from the given InputStream.
create(InputStream, Map<String, DocumentFormatProperties>) - Static method in class org.jodconverter.core.document.JsonDocumentFormatRegistry
Creates a JsonDocumentFormatRegistry from the given InputStream.
create(String) - Static method in class org.jodconverter.core.document.JsonDocumentFormatRegistry
Creates a JsonDocumentFormatRegistry from the given source.
create(String, Map<String, DocumentFormatProperties>) - Static method in class org.jodconverter.core.document.JsonDocumentFormatRegistry
Creates a JsonDocumentFormatRegistry from the given source.
CSV - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Comma Separated Values.

D

DEFAULT_TASK_EXECUTION_TIMEOUT - Static variable in class org.jodconverter.core.office.AbstractOfficeManagerPool
 
DEFAULT_TASK_QUEUE_TIMEOUT - Static variable in class org.jodconverter.core.office.AbstractOfficeManagerPool
 
DefaultDocumentFormatRegistry - Class in org.jodconverter.core.document
Default DocumentFormat registry.
DefaultDocumentFormatRegistryInstanceHolder - Class in org.jodconverter.core.document
Holds the default DocumentFormatRegistry instance.
delete(File) - Static method in class org.jodconverter.core.util.FileUtils
Deletes a file.
deleteOrRenameFile(File, long, long) - Static method in class org.jodconverter.core.office.OfficeUtils
Deletes a file with a fallback (renaming) on deletion failure.
deleteQuietly(File) - Static method in class org.jodconverter.core.util.FileUtils
Deletes a file, never throwing an exception.
DOC - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Microsoft Word 97-2003.
DocumentConverter - Interface in org.jodconverter.core
A DocumentConverter is responsible to execute the conversion of documents using an office manager.
DocumentFamily - Enum in org.jodconverter.core.document
Represents a document type supported by office.
DocumentFormat - Class in org.jodconverter.core.document
Contains the required information used to deal with a specific document format .
DocumentFormat.Builder - Class in org.jodconverter.core.document
A builder for constructing a DocumentFormat.
DocumentFormatProperties - Class in org.jodconverter.core.document
Contains properties that will be applied when loading(opening) and storing(saving) document for a specific DocumentFormat.
DocumentFormatProperties() - Constructor for class org.jodconverter.core.document.DocumentFormatProperties
 
DocumentFormatRegistry - Interface in org.jodconverter.core.document
A class implementing this interface should keep a collection of document format supported by office.
DocumentFormatRegistryException - Exception in org.jodconverter.core.document
Exception thrown when a DefaultDocumentFormatRegistry cannot be created and initialized properly.
DocumentFormatRegistryException(String, Throwable) - Constructor for exception org.jodconverter.core.document.DocumentFormatRegistryException
Constructs an exception with the specified detail message and cause.
DocumentSpecs - Interface in org.jodconverter.core.job
An interface that provides, for a document, the physical file and format required by a conversion process.
DocumentSpecsIOException - Exception in org.jodconverter.core.job
Wraps an IOException with an unchecked exception while performing IO operations on a DocumentSpecs implementation.
DocumentSpecsIOException(String, Throwable) - Constructor for exception org.jodconverter.core.job.DocumentSpecsIOException
Constructs an exception with the specified detail message and cause.
DOCX - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Microsoft Word 2007-2013 XML.
doExecute() - Method in class org.jodconverter.core.job.AbstractConversionJob
Executes the conversion and blocks until the conversion terminates.
doExecute(OfficeTask) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
Performs the execution of a task.
doStart() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
Allow subclasses to perform operation when the office manager is started.
doStop() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
Allow subclasses to perform operation when the office manager is stopped.
DOTX - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Word Open XML Document Template.

E

endsWithAny(String, String...) - Static method in class org.jodconverter.core.util.StringUtils
Check if a string ends with any of the provided case-sensitive suffixes.
execute() - Method in class org.jodconverter.core.job.AbstractConversionJob
 
execute() - Method in interface org.jodconverter.core.job.ConversionJob
Executes a conversion and blocks until the conversion terminates.
execute(OfficeTask) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool
 
execute(OfficeTask) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
 
execute(long, long) - Method in class org.jodconverter.core.office.AbstractRetryable
Executes the task without a starting delay.
execute(long, long, long) - Method in class org.jodconverter.core.office.AbstractRetryable
Executes the task without a starting delay.
execute(OfficeTask) - Method in interface org.jodconverter.core.office.OfficeManager
Executes the specified task and blocks until the task terminates.
execute(OfficeContext) - Method in interface org.jodconverter.core.task.OfficeTask
Executes the task in the specified context.
extension(String) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Specifies the extension associated with the document format.

F

FileUtils - Class in org.jodconverter.core.util
Contains files helper functions.
FODG - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Drawing Flat XML.
FODP - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Presentation Flat XML.
FODS - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Spreadsheet Flat XML.
FODT - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Text Flat XML.
formatRegistry - Variable in class org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified
 
formatRegistry - Variable in class org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder
 
formatRegistry(DocumentFormatRegistry) - Method in class org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder
Specifies the DocumentFormatRegistry which contains the document formats that will be supported by this converter.
formatRegistry - Variable in class org.jodconverter.core.job.AbstractConverter
 
from(DocumentFormat) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Initializes the builder by copying the properties of the specified document format.

G

getBaseName(String) - Static method in class org.jodconverter.core.util.FileUtils
Gets the name minus the path and extension from a full filename.
getDefaultWorkingDir() - Static method in class org.jodconverter.core.office.OfficeUtils
Gets the default working directory, which is the java.io.tmpdir system property.
getExtension() - Method in class org.jodconverter.core.document.DocumentFormat
Gets the extension associated with the document format.
getExtension(String) - Static method in class org.jodconverter.core.util.FileUtils
Gets the file extension from a full filename.
getExtensions() - Method in class org.jodconverter.core.document.DocumentFormat
Gets the file name extensions of the document format.
getFile() - Method in class org.jodconverter.core.job.AbstractDocumentSpecs
 
getFile() - Method in interface org.jodconverter.core.job.DocumentSpecs
Gets the file where is located the document.
getFile() - Method in class org.jodconverter.core.job.SourceDocumentSpecsFromInputStream
 
getFile() - Method in class org.jodconverter.core.job.TargetDocumentSpecsFromOutputStream
 
getFormat() - Method in class org.jodconverter.core.job.AbstractDocumentSpecs
 
getFormat() - Method in interface org.jodconverter.core.job.DocumentSpecs
Gets the DocumentFormat specification for the document.
getFormatByExtension(String) - Static method in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Gets a document format for the specified extension.
getFormatByExtension(String) - Method in interface org.jodconverter.core.document.DocumentFormatRegistry
Gets a document format for the specified extension.
getFormatByExtension(String) - Method in class org.jodconverter.core.document.SimpleDocumentFormatRegistry
 
getFormatByMediaType(String) - Static method in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Gets a document format for the specified media type.
getFormatByMediaType(String) - Method in interface org.jodconverter.core.document.DocumentFormatRegistry
Gets a document format for the specified media type.
getFormatByMediaType(String) - Method in class org.jodconverter.core.document.SimpleDocumentFormatRegistry
 
getFormatRegistry() - Method in interface org.jodconverter.core.DocumentConverter
Gets all the DocumentFormat supported by the converter.
getFormatRegistry() - Method in class org.jodconverter.core.job.AbstractConverter
 
getInputFamily() - Method in class org.jodconverter.core.document.DocumentFormat
Gets the input DocumentFamily of the document format.
getInstance() - Static method in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Gets the default instance of the class.
getInstance() - Static method in class org.jodconverter.core.document.DefaultDocumentFormatRegistryInstanceHolder
Gets the default DocumentFormatRegistry instance.
getInstance() - Static method in class org.jodconverter.core.office.InstalledOfficeManagerHolder
Gets the static instance of the static holder class.
getLoad() - Method in class org.jodconverter.core.document.DocumentFormatProperties
Gets the properties applied when loading(opening) a document.
getLoadProperties() - Method in class org.jodconverter.core.document.DocumentFormat
Gets the properties required to load(open) a document of this format.
getMediaType() - Method in class org.jodconverter.core.document.DocumentFormat
Gets the media (mime) type of the format.
getName() - Method in class org.jodconverter.core.document.DocumentFormat
Gets the name of the format.
getName(String) - Static method in class org.jodconverter.core.util.FileUtils
Gets the name minus the path from a full filename.
getOutputFormats(DocumentFamily) - Static method in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Gets all the DocumentFormats of a given family.
getOutputFormats(DocumentFamily) - Method in interface org.jodconverter.core.document.DocumentFormatRegistry
Gets all the DocumentFormats of a given family.
getOutputFormats(DocumentFamily) - Method in class org.jodconverter.core.document.SimpleDocumentFormatRegistry
 
getStore() - Method in class org.jodconverter.core.document.DocumentFormatProperties
Gets the properties applied when storing(saving) a document for each supported families.
getStoreProperties() - Method in class org.jodconverter.core.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.core.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.core.document.DefaultDocumentFormatRegistry
Graphic Interchange Format.

H

handleExecuteTimeoutException(TimeoutException) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
Handles a timeout exception raised while executing a task.
HTML - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
HTML.

I

inputFamily(DocumentFamily) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Specifies the input (when a document is loaded) DocumentFamily associated with the document format.
install - Variable in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
 
install() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
Specifies whether the office manager that will be created by this builder will then set the unique instance of the InstalledOfficeManagerHolder class.
InstalledOfficeManagerHolder - Class in org.jodconverter.core.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.
IOUtils - Class in org.jodconverter.core.util
Contains IO helper functions.
IS_OS_AIX - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is AIX, false otherwise.
IS_OS_FREE_BSD - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is MAC, false otherwise.
IS_OS_HP_UX - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is HP-UX, false otherwise.
IS_OS_IRIX - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is Irix, false otherwise.
IS_OS_LINUX - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is Linux, false otherwise.
IS_OS_MAC - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is MAC, false otherwise.
IS_OS_MAC_OSX - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is Mac OS X, false otherwise.
IS_OS_NET_BSD - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is NetBSD, false otherwise.
IS_OS_OPEN_BSD - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is OpenBSD, false otherwise.
IS_OS_SOLARIS - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is Solaris, false otherwise.
IS_OS_SUN_OS - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is SunOS, false otherwise.
IS_OS_UNIX - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is Unix, false otherwise.
IS_OS_WINDOWS - Static variable in class org.jodconverter.core.util.OSUtils
true if the current OS is Windows, false otherwise.
isBlank(String) - Static method in class org.jodconverter.core.util.StringUtils
Gets whether the specified string is null, empty or blank (only whitespace).
isEmpty(String) - Static method in class org.jodconverter.core.util.StringUtils
Gets whether the specified string is null or empty.
isNotBlank(String) - Static method in class org.jodconverter.core.util.StringUtils
Gets whether the specified string is not null, empty or blank (only whitespace).
isNotEmpty(String) - Static method in class org.jodconverter.core.util.StringUtils
Gets whether the specified string is not null nor empty.
isRunning() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool
 
isRunning() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
 
isRunning() - Method in interface org.jodconverter.core.office.OfficeManager
Gets whether the manager is running.
isTrue(boolean, String) - Static method in class org.jodconverter.core.util.AssertUtils
Validates that the argument condition is true.

J

JPEG - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Joint Photographic Experts Group.
JsonDocumentFormatRegistry - Class in org.jodconverter.core.document
A JsonDocumentFormatRegistry contains a collection of DocumentFormat supported by office that has been loaded from a JSON source.
JsonDocumentFormatRegistry() - Constructor for class org.jodconverter.core.document.JsonDocumentFormatRegistry
Creates a new instance of the class.

L

loadFilterName(String) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Sets the FilterName property to the builder that will be applied when loading (open) a document of this format.
loadFilterOptions(String) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Sets the FilterOptions property to the builder that will be applied when loading (open) a document of this format.
loadProperty(String, Object) - Method in class org.jodconverter.core.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 class org.jodconverter.core.office.AbstractOfficeManagerPool
 
makeTemporaryFile(String) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool
 
makeTemporaryFile() - Method in interface org.jodconverter.core.office.TemporaryFileMaker
Creates a new temporary file without an extension.
makeTemporaryFile(String) - Method in interface org.jodconverter.core.office.TemporaryFileMaker
Creates a new temporary file with the specified extension.
mediaType(String) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Specifies the media (mime) type of the document format.

N

name(String) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Specifies the name of the document format.
NamedThreadFactory - Class in org.jodconverter.core.office
A ThreadFactory that allows for custom thread names.
NamedThreadFactory(String) - Constructor for class org.jodconverter.core.office.NamedThreadFactory
Creates a new instance of the factory.
NamedThreadFactory(String, boolean) - Constructor for class org.jodconverter.core.office.NamedThreadFactory
Creates a new instance of the factory.
newThread(Runnable) - Method in class org.jodconverter.core.office.NamedThreadFactory
 
notBlank(String, String) - Static method in class org.jodconverter.core.util.AssertUtils
Validates that the specified string is neither null, nor empty, nor blank (only whitespace).
notEmpty(Collection<T>, String) - Static method in class org.jodconverter.core.util.AssertUtils
Validates that the specified argument collection is neither null nor empty.
notEmpty(T[], String) - Static method in class org.jodconverter.core.util.AssertUtils
Validates that the specified argument array is neither null nor empty.
notEmpty(String, String) - Static method in class org.jodconverter.core.util.AssertUtils
Validates that the specified string is neither null nor empty.
notNull(Object, String) - Static method in class org.jodconverter.core.util.AssertUtils
Validates that the specified argument is not null.

O

ODG - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Drawing.
ODP - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Presentation.
ODS - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Spreadsheet.
ODT - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Text.
OfficeContext - Interface in org.jodconverter.core.office
Base interface for all office context interfaces.
OfficeException - Exception in org.jodconverter.core.office
An exception that provides information on an error while dealing with office.
OfficeException(String) - Constructor for exception org.jodconverter.core.office.OfficeException
Constructs a new office exception with the specified detail message.
OfficeException(String, Throwable) - Constructor for exception org.jodconverter.core.office.OfficeException
Constructs a new office exception with the specified detail message and cause.
officeManager - Variable in class org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified
 
officeManager - Variable in class org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder
 
officeManager(OfficeManager) - Method in class org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder
Specifies the OfficeManager the converter will use to execute office tasks.
officeManager - Variable in class org.jodconverter.core.job.AbstractConverter
 
OfficeManager - Interface in org.jodconverter.core.office
An office manager knows how to execute an OfficeTask.
OfficeTask - Interface in org.jodconverter.core.task
Represents a task executed by an OfficeManager.
OfficeUtils - Class in org.jodconverter.core.office
Provides helper functions for office.
onComplete(File) - Method in interface org.jodconverter.core.job.TargetDocumentSpecs
Called if the conversion was completed successfully.
onComplete(File) - Method in class org.jodconverter.core.job.TargetDocumentSpecsFromOutputStream
 
onConsumed(File) - Method in interface org.jodconverter.core.job.SourceDocumentSpecs
Called when the file was consumed and is no longer required by the converter.
onConsumed(File) - Method in class org.jodconverter.core.job.SourceDocumentSpecsFromInputStream
 
onFailure(File, Exception) - Method in interface org.jodconverter.core.job.TargetDocumentSpecs
Called if the conversion finished with an exception.
org.jodconverter.core - package org.jodconverter.core
This package contains the DocumentConverter interface offering a fluent API to execute document conversions.
org.jodconverter.core.document - package org.jodconverter.core.document
This package contains the interfaces/classes used by DocumentConverter implementations to convert from/to specific document formats.
org.jodconverter.core.job - package org.jodconverter.core.job
This package contains the interfaces/classes used by the DocumentConverter implementations that offers a fluent API to execute document conversions.
org.jodconverter.core.office - package org.jodconverter.core.office
This package contains the interfaces/classes related to the use of a pool of separate office managers launched by JODConverter.
org.jodconverter.core.task - package org.jodconverter.core.task
This package provides the base interfaces/classes a conversion task must implement in order to be executed by an OfficeManager.
org.jodconverter.core.util - package org.jodconverter.core.util
 
OSUtils - Class in org.jodconverter.core.util
Contains os helper functions.
OTG - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Drawing Template.
OTP - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Presentation Template.
OTS - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Spreadsheet Template.
OTT - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenDocument Text Template.

P

PDF - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Portable Document Format.
PNG - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Portable Network Graphics.
POTX - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Microsoft PowerPoint 2007-2013 XML template.
PPT - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Microsoft PowerPoint 97-2003.
PPTX - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Microsoft PowerPoint 2007-2013 XML.

R

readFileToString(File, Charset) - Static method in class org.jodconverter.core.util.FileUtils
Reads the contents of a file into a String.
RetryTimeoutException - Exception in org.jodconverter.core.office
A RetryTimeoutException is thrown by an AbstractRetryable when it is unable to execute its task within a specified amount of time.
RetryTimeoutException(Throwable) - Constructor for exception org.jodconverter.core.office.RetryTimeoutException
Constructs a new exception with the specified cause.
RTF - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Rich Text Format.

S

setAvailable(boolean) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
Sets the availability of this manager entry.
setAvailable(boolean) - Method in class org.jodconverter.core.office.SuspendableThreadPoolExecutor
Sets the availability of this executor.
setEntries(List<E>) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool
Sets the manager entries.
setInstance(DocumentFormatRegistry) - Static method in class org.jodconverter.core.document.DefaultDocumentFormatRegistryInstanceHolder
Sets the default DocumentFormatRegistry instance.
setInstance(OfficeManager) - Static method in class org.jodconverter.core.office.InstalledOfficeManagerHolder
Sets the static instance of the static holder class.
SimpleDocumentFormatRegistry - Class in org.jodconverter.core.document
A SimpleDocumentFormatRegistry contains a collection of document formats supported by office.
SimpleDocumentFormatRegistry() - Constructor for class org.jodconverter.core.document.SimpleDocumentFormatRegistry
 
source - Variable in class org.jodconverter.core.job.AbstractConversionJob
 
source - Variable in class org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified
 
source - Variable in class org.jodconverter.core.task.AbstractOfficeTask
 
SourceDocumentSpecs - Interface in org.jodconverter.core.job
An interface that provides the behavior to apply when a source file is no longer required by a conversion process.
SourceDocumentSpecsFromFile - Class in org.jodconverter.core.job
Source document specifications for from a file.
SourceDocumentSpecsFromFile(File) - Constructor for class org.jodconverter.core.job.SourceDocumentSpecsFromFile
Creates specs from the specified file.
SourceDocumentSpecsFromInputStream - Class in org.jodconverter.core.job
Source document specifications for from an input stream.
SourceDocumentSpecsFromInputStream(InputStream, TemporaryFileMaker, boolean) - Constructor for class org.jodconverter.core.job.SourceDocumentSpecsFromInputStream
Creates specs from the specified stream.
start() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool
 
start() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
 
start() - Method in interface org.jodconverter.core.office.OfficeManager
Starts the manager.
stop() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool
 
stop() - Method in class org.jodconverter.core.office.AbstractOfficeManagerPoolEntry
 
stop() - Method in interface org.jodconverter.core.office.OfficeManager
Stops the manager.
stopQuietly(OfficeManager) - Static method in class org.jodconverter.core.office.OfficeUtils
Stops an OfficeManager unconditionally.
storeFilterName(DocumentFamily, String) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Sets the FilterName property that will be applied when storing (save) a document to this format from a document of the specified family.
storeFilterOptions(DocumentFamily, String) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Sets the FilterOptions property that will be applied when storing (save) a document to this format from a document of the specified family.
storeProperty(DocumentFamily, String, Object) - Method in class org.jodconverter.core.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.
StringUtils - Class in org.jodconverter.core.util
Contains string helper functions.
SuspendableThreadPoolExecutor - Class in org.jodconverter.core.office
A thread pool executor that can be suspended.
SVG - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Scalable Vector Graphics.
SWF - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Macromedia Flash.
SXC - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenOffice.org 1.0 Spreadsheet.
SXI - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenOffice.org 1.0 Presentation.
SXW - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
OpenOffice.org 1.0 Text Document.

T

target - Variable in class org.jodconverter.core.job.AbstractConversionJob
 
TargetDocumentSpecs - Interface in org.jodconverter.core.job
An interface that provides the behavior to apply when a target file is no longer required by a conversion process.
TargetDocumentSpecsFromFile - Class in org.jodconverter.core.job
Target document specifications for from a file.
TargetDocumentSpecsFromFile(File) - Constructor for class org.jodconverter.core.job.TargetDocumentSpecsFromFile
Creates specs for the specified file.
TargetDocumentSpecsFromOutputStream - Class in org.jodconverter.core.job
Target document specifications for from an input stream.
TargetDocumentSpecsFromOutputStream(OutputStream, TemporaryFileMaker, boolean) - Constructor for class org.jodconverter.core.job.TargetDocumentSpecsFromOutputStream
Creates specs for the specified output stream.
taskExecutionTimeout - Variable in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
 
taskExecutionTimeout(Long) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
Specifies the maximum time allowed to process a task.
taskQueueTimeout - Variable in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
 
taskQueueTimeout(Long) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
Specifies the maximum living time of a task in the conversion queue.
TemporaryException - Exception in org.jodconverter.core.office
Represents an error condition that can be temporary, i.e.
TemporaryException(String) - Constructor for exception org.jodconverter.core.office.TemporaryException
Constructs a new exception with the specified message.
TemporaryException(Throwable) - Constructor for exception org.jodconverter.core.office.TemporaryException
Constructs a new exception with the specified cause.
TemporaryFileMaker - Interface in org.jodconverter.core.office
Provides services to create temporary files.
TIFF - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Tagged Image File Format.
to(File) - Method in class org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified
 
to(OutputStream) - Method in class org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified
 
to(OutputStream, boolean) - Method in class org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified
 
to(AbstractTargetDocumentSpecs) - Method in class org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified
Configures the current conversion to write the result using the specified specifications.
to(File) - Method in interface org.jodconverter.core.job.ConversionJobWithSourceSpecified
Configures the current conversion to write the result to the specified target.
to(OutputStream) - Method in interface org.jodconverter.core.job.ConversionJobWithSourceSpecified
Configures the current conversion to write the result to the specified OutputStream.
to(OutputStream, boolean) - Method in interface org.jodconverter.core.job.ConversionJobWithSourceSpecified
Configures the current conversion to write the result to the specified OutputStream.
toString() - Method in class org.jodconverter.core.document.DocumentFormat
 
toString() - Method in class org.jodconverter.core.job.AbstractDocumentSpecs
 
toString() - Method in class org.jodconverter.core.task.AbstractOfficeTask
 
toString(InputStream, Charset) - Static method in class org.jodconverter.core.util.IOUtils
Reads all char from an input stream and writes them to a string.
TSV - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Tab Separated Values.
TXT - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Plain Text.

U

unmodifiable(boolean) - Method in class org.jodconverter.core.document.DocumentFormat.Builder
Specifies whether the document format is unmodifiable after creation.
unmodifiableCopy(DocumentFormat) - Static method in class org.jodconverter.core.document.DocumentFormat
Creates a new unmodifiable DocumentFormat from the specified format.

V

validateWorkingDir(File) - Static method in class org.jodconverter.core.office.OfficeUtils
Validates that the specified File instance is a valid working directory.
valueOf(String) - Static method in enum org.jodconverter.core.document.DocumentFamily
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jodconverter.core.document.DocumentFamily
Returns an array containing the constants of this enum type, in the order they are declared.
VSD - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Visio format.
VSDX - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
New Visio format.

W

workingDir - Variable in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
 
workingDir(File) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
Specifies the directory where temporary files and directories are created.
workingDir(String) - Method in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder
Specifies the directory where temporary files and directories are created.
WPD - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
WordPerfect.

X

XHTML - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
XHTML.
XLS - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Microsoft Excel 97-2003.
XLSX - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Microsoft Excel 2007-2013 XML.
XLTX - Static variable in class org.jodconverter.core.document.DefaultDocumentFormatRegistry
Microsoft Excel 2007-2013 XML Spreadsheet template.
A B C D E F G H I J L M N O P R S T U V W X 
Skip navigation links
JODConverter Core 4.4.5 API

Copyright © 2016 - present; JODConverter.org. All rights reserved.