A C D E F G H I J K M O P R S T W X

A

APPLICATION - Static variable in class com.documents4j.api.DocumentType.Value

as(DocumentType) - Method in interface com.documents4j.api.IConversionJobWithSourceUnspecified

Defines the source document type for the given input document.

as(DocumentType) - Method in interface com.documents4j.api.IConversionJobWithTargetUnspecified

Defines the target document type for the given target.

C

com.documents4j.api - package com.documents4j.api

com.documents4j.throwables - package com.documents4j.throwables

compareTo(DocumentType) - Method in class com.documents4j.api.DocumentType

ConversionFormatException - Exception in com.documents4j.throwables

Thrown if the converter was requested to translate a file into a DocumentType that is does not support.

ConversionFormatException(String) - Constructor for exception com.documents4j.throwables.ConversionFormatException

ConversionFormatException(String, Throwable) - Constructor for exception com.documents4j.throwables.ConversionFormatException

ConversionInputException - Exception in com.documents4j.throwables

Thrown if the source file that was provided for a conversion appears to not be of the provided DocumentType.

ConversionInputException(String) - Constructor for exception com.documents4j.throwables.ConversionInputException

ConversionInputException(String, Throwable) - Constructor for exception com.documents4j.throwables.ConversionInputException

convert(InputStream) - Method in interface com.documents4j.api.IConverter

Converts a source that is represented as a InputStream.

convert(InputStream, boolean) - Method in interface com.documents4j.api.IConverter

Converts a source that is represented as a InputStream.

convert(IInputStreamSource) - Method in interface com.documents4j.api.IConverter

Invokes a callback for the dynamic generation of a input stream source which is additionally informed about the consumption of this source.

convert(File) - Method in interface com.documents4j.api.IConverter

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

convert(IFileSource) - Method in interface com.documents4j.api.IConverter

Invokes a callback for the dynamic generation of a file source which is additionally informed about the consumption of a source.

ConverterAccessException - Exception in com.documents4j.throwables

Thrown when a converter is not operational.

ConverterAccessException(String) - Constructor for exception com.documents4j.throwables.ConverterAccessException

ConverterAccessException(String, Throwable) - Constructor for exception com.documents4j.throwables.ConverterAccessException

ConverterException - Exception in com.documents4j.throwables

A general exception thrown by the methods in IConverter.

ConverterException(String) - Constructor for exception com.documents4j.throwables.ConverterException

ConverterException(String, Throwable) - Constructor for exception com.documents4j.throwables.ConverterException

CSV - Static variable in class com.documents4j.api.DocumentType

CSV - Static variable in class com.documents4j.api.DocumentType.Value

D

DOC - Static variable in class com.documents4j.api.DocumentType

DOC - Static variable in class com.documents4j.api.DocumentType.Value

DocumentType - Class in com.documents4j.api

Represents an immutable document MIME type.

DocumentType(String, String) - Constructor for class com.documents4j.api.DocumentType

Creates a new document type.

DocumentType(String) - Constructor for class com.documents4j.api.DocumentType

Creates a new document type.

DocumentType.Value - Class in com.documents4j.api

A holder type for type and subtype names of known DocumentTypes.

DOCX - Static variable in class com.documents4j.api.DocumentType

DOCX - Static variable in class com.documents4j.api.DocumentType.Value

E

equals(Object) - Method in class com.documents4j.api.DocumentType

EXCEL_ANY - Static variable in class com.documents4j.api.DocumentType.Value

execute() - Method in interface com.documents4j.api.IConversionJob

Executes a conversion and blocks until the conversion terminates.

F

FileSystemInteractionException - Exception in com.documents4j.throwables

This exception is thrown when a file on the file system cannot be read or written or when a script file cannot be executed.

FileSystemInteractionException(String) - Constructor for exception com.documents4j.throwables.FileSystemInteractionException

FileSystemInteractionException(String, Throwable) - Constructor for exception com.documents4j.throwables.FileSystemInteractionException

G

getFile() - Method in interface com.documents4j.api.IFileSource

Invoked when the converter requests a file for conversion.

getInputStream() - Method in interface com.documents4j.api.IInputStreamSource

Invoked when the converter requests a new input stream with data for conversion.

getSubtype() - Method in class com.documents4j.api.DocumentType

getSupportedConversions() - Method in interface com.documents4j.api.IConverter

Returns a mapping of all conversions that are supported by the backing conversion engine.

getType() - Method in class com.documents4j.api.DocumentType

H

hashCode() - Method in class com.documents4j.api.DocumentType

I

IConversionJob - Interface in com.documents4j.api

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

IConversionJobWithPriorityUnspecified - Interface in com.documents4j.api

A sufficiently specified conversion with default priority that is not yet applied to the converter.

IConversionJobWithSourceSpecified - Interface in com.documents4j.api

A conversion with a specified source for the conversion.

IConversionJobWithSourceUnspecified - Interface in com.documents4j.api

A conversion job where the document type of the source document is not yet specified.

IConversionJobWithTargetUnspecified - Interface in com.documents4j.api

A conversion job where the document type of the target document is not yet specified.

IConverter - Interface in com.documents4j.api

A converter that allows the conversion of documents.

IFileConsumer - Interface in com.documents4j.api

Consumes a file after a terminated conversion.

IFileSource - Interface in com.documents4j.api

A callback interface that provides files to be converted just-in-time.

IInputStreamConsumer - Interface in com.documents4j.api

Consumes an input stream after a terminated conversion.

IInputStreamSource - Interface in com.documents4j.api

A callback interface that provides input stream with conversion data just-in-time.

isOperational() - Method in interface com.documents4j.api.IConverter

Checks if this converter is currently operational, i.e. it can convert documents and is not shut down.

J

JOB_PRIORITY_HIGH - Static variable in interface com.documents4j.api.IConverter

A conversion of high priority.

JOB_PRIORITY_LOW - Static variable in interface com.documents4j.api.IConverter

A conversion of low priority.

JOB_PRIORITY_NORMAL - Static variable in interface com.documents4j.api.IConverter

A conversion of normal priority.

K

kill() - Method in interface com.documents4j.api.IConverter

Shuts down this converter immediately.

M

MHTML - Static variable in class com.documents4j.api.DocumentType

MHTML - Static variable in class com.documents4j.api.DocumentType.Value

MS_EXCEL - Static variable in class com.documents4j.api.DocumentType

MS_WORD - Static variable in class com.documents4j.api.DocumentType

O

ODS - Static variable in class com.documents4j.api.DocumentType

ODS - Static variable in class com.documents4j.api.DocumentType.Value

onCancel(File) - Method in interface com.documents4j.api.IFileConsumer

Invoked if the conversion was cancelled.

onCancel() - Method in interface com.documents4j.api.IInputStreamConsumer

Invoked if the conversion was cancelled.

onComplete(File) - Method in interface com.documents4j.api.IFileConsumer

Invoked if the conversion was completed successfully.

onComplete(InputStream) - Method in interface com.documents4j.api.IInputStreamConsumer

Invoked if the conversion was completed successfully.

onConsumed(File) - Method in interface com.documents4j.api.IFileSource

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

onConsumed(InputStream) - Method in interface com.documents4j.api.IInputStreamSource

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

onException(File, Exception) - Method in interface com.documents4j.api.IFileConsumer

Invoked if the conversion finished with an exception.

onException(Exception) - Method in interface com.documents4j.api.IInputStreamConsumer

Invoked if the conversion finished with an exception.

P

PDF - Static variable in class com.documents4j.api.DocumentType

PDF - Static variable in class com.documents4j.api.DocumentType.Value

PDFA - Static variable in class com.documents4j.api.DocumentType

PDFA - Static variable in class com.documents4j.api.DocumentType.Value

PLAIN - Static variable in class com.documents4j.api.DocumentType.Value

prioritizeWith(int) - Method in interface com.documents4j.api.IConversionJobWithPriorityUnspecified

Sets a priority for the conversion that is currently specified.

R

RTF - Static variable in class com.documents4j.api.DocumentType

RTF - Static variable in class com.documents4j.api.DocumentType.Value

S

schedule() - Method in interface com.documents4j.api.IConversionJob

Schedules the specified conversion to be executed in the background.

shutDown() - Method in interface com.documents4j.api.IConverter

Shuts down this converter gracefully.

T

TEXT - Static variable in class com.documents4j.api.DocumentType

TEXT - Static variable in class com.documents4j.api.DocumentType.Value

to(File) - Method in interface com.documents4j.api.IConversionJobWithSourceSpecified

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

to(File, IFileConsumer) - Method in interface com.documents4j.api.IConversionJobWithSourceSpecified

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

to(OutputStream) - Method in interface com.documents4j.api.IConversionJobWithSourceSpecified

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

to(OutputStream, boolean) - Method in interface com.documents4j.api.IConversionJobWithSourceSpecified

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

to(IInputStreamConsumer) - Method in interface com.documents4j.api.IConversionJobWithSourceSpecified

Configures the current conversion to write the result to invoke the given callback when the conversion terminates.

toString() - Method in class com.documents4j.api.DocumentType

W

WORD_ANY - Static variable in class com.documents4j.api.DocumentType.Value

X

XLS - Static variable in class com.documents4j.api.DocumentType.Value

XLS - Static variable in class com.documents4j.api.DocumentType

XLSX - Static variable in class com.documents4j.api.DocumentType.Value

XLSX - Static variable in class com.documents4j.api.DocumentType

XML - Static variable in class com.documents4j.api.DocumentType.Value

XML - Static variable in class com.documents4j.api.DocumentType

A C D E F G H I J K M O P R S T W X