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

A

AbstractFilterChain - Class in org.jodconverter.local.filter

Base class of a FilterChain.

AbstractFilterChain() - Constructor for class org.jodconverter.local.filter.AbstractFilterChain

Creates a FilterChain.

AbstractFilterChain(Filter...) - Constructor for class org.jodconverter.local.filter.AbstractFilterChain

Creates a FilterChain that will contains the specified filters.

AbstractFilterChain(boolean, Filter...) - Constructor for class org.jodconverter.local.filter.AbstractFilterChain

Creates a FilterChain that will contains the specified filters.

AbstractLocalOfficeTask - Class in org.jodconverter.local.task

Base class for all local office tasks implementation.

AbstractLocalOfficeTask(SourceDocumentSpecs) - Constructor for class org.jodconverter.local.task.AbstractLocalOfficeTask

Creates a new task with the specified source document.

AbstractLocalOfficeTask(SourceDocumentSpecs, Map<String, Object>) - Constructor for class org.jodconverter.local.task.AbstractLocalOfficeTask

Creates a new task with the specified source document.

AbstractProcessManager - Class in org.jodconverter.local.process

Base class for all process manager implementations included in the standard JODConverter distribution.

AbstractProcessManager() - Constructor for class org.jodconverter.local.process.AbstractProcessManager

Initializes a new instance of the class.

AbstractTextContentInserterFilter - Class in org.jodconverter.local.filter.text

Base class for all filter used to insert a TextContent into a document.

AbstractTextContentInserterFilter(int, int) - Constructor for class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Creates a new filter that will insert a text content (shape) at the specified location while converting a document.

AbstractTextContentInserterFilter(Map<String, Object>) - Constructor for class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Creates a new filter that will insert a text content (shape) using the specified shape properties while converting a document.

AbstractTextContentInserterFilter(Dimension, int, int) - Constructor for class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Creates a new filter that will insert a text content (shape) of the specified size at the specified location while converting a document.

AbstractTextContentInserterFilter(Dimension, Map<String, Object>) - Constructor for class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Creates a new filter that will insert a text content (shape) of the specified size using the specified shape properties while converting a document.

addConnectionEventListener(OfficeConnectionEventListener) - Method in class org.jodconverter.local.office.OfficeConnection

Adds a listener to the connection event listener list of this connection.

addFilter(Filter) - Method in class org.jodconverter.local.filter.AbstractFilterChain

addFilter(Filter) - Method in interface org.jodconverter.local.filter.FilterChain

Adds a filter to the chain.

afterStartProcessDelay(Long) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the delay, in milliseconds, after an attempt to start an office process before doing anything else.

appendProperties(Map<String, Object>, Map<String, Object>) - Static method in class org.jodconverter.local.task.AbstractLocalOfficeTask

applyAnchorPageNoFix(XTextDocument, XTextCursor) - Method in class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Jumps to the page specified by the "AnchorPageNo" if present in the shape properties if this filter.

attempt() - Method in class org.jodconverter.local.office.ConnectRetryable

attempt() - Method in class org.jodconverter.local.office.ExitCodeRetryable

B

build() - Method in class org.jodconverter.local.LocalConverter.Builder

build() - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

build() - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

builder() - Static method in class org.jodconverter.local.LocalConverter

Creates a new builder instance.

builder() - Static method in class org.jodconverter.local.office.ExternalOfficeManager

Creates a new builder instance.

builder() - Static method in class org.jodconverter.local.office.LocalOfficeManager

Creates a new builder instance.

buildOfficeUrls(List<Integer>, List<String>) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Builds an array of OfficeUrl from an array of port numbers and an array of pipe names.

buildOfficeUrls(String, List<Integer>, List<String>) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Builds an array of OfficeUrl from an array of port numbers and an array of pipe names.

C

Calc - Class in org.jodconverter.local.office.utils

A collection of utility functions to make Office Calc documents (Spreadsheet) easier to use.

CALC_SERVICE - Static variable in class org.jodconverter.local.office.utils.Lo

canFindPid() - Method in interface org.jodconverter.local.process.ProcessManager

Indicates whether the pid of the process can be found using a command line.

canFindPid() - Method in class org.jodconverter.local.process.PureJavaProcessManager

CHAIN - Static variable in class org.jodconverter.local.filter.NoopFilter

Singleton instance of a FilterChain that will always contain a single NoopFilter that won't call the next filter in the chain.

CHAIN - Static variable in class org.jodconverter.local.filter.RefreshFilter

Singleton instance of a FilterChain that will always contain a single RefreshFilter that won't call the next filter in the chain.

closeDocument(XComponent) - Method in class org.jodconverter.local.task.AbstractLocalOfficeTask

compareVersions(String, String, int) - Static method in class org.jodconverter.local.office.utils.Info

Compares two versions strings (ex.

connect() - Method in class org.jodconverter.local.office.OfficeConnection

Establishes the connection to an office instance.

connectFailFast(Boolean) - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

Controls whether the manager will "fail fast" if the connection to the external process fails.

connectOnStart(Boolean) - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

Specifies whether a connection must be attempted on AbstractOfficeManagerPool.start()? If false, a connection will only be attempted the first time an OfficeTask is executed.

ConnectRetryable - Class in org.jodconverter.local.office

Performs a connection to an office process.

ConnectRetryable(OfficeConnection) - Constructor for class org.jodconverter.local.office.ConnectRetryable

Creates a new instance of the class for the specified process and connection.

connectRetryInterval(Long) - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

Specifies the delay, in milliseconds, between each try when trying to connect to office.

connectTimeout(Long) - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

Specifies the timeout, in milliseconds, after which a connection attempt will fail.

consume(String) - Method in interface org.jodconverter.local.process.StreamPumper.LineConsumer

Consumes a line read from the input stream.

convert(File) - Static method in class org.jodconverter.local.JodConverter

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

convert(InputStream) - Static method in class org.jodconverter.local.JodConverter

Converts a source stream input stream.

convert(InputStream, boolean) - Static method in class org.jodconverter.local.JodConverter

Converts a source stream input stream.

convert(AbstractSourceDocumentSpecs) - Method in class org.jodconverter.local.LocalConverter

copy() - Method in class org.jodconverter.local.filter.DefaultFilterChain

copy() - Method in interface org.jodconverter.local.filter.FilterChain

Creates and returns a copy of this object.

copy() - Method in class org.jodconverter.local.filter.UnmodifiableFilterChain

createDefaultShapeProperties(int, int) - Static method in class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Creates the default shape properties that would insert text content at the specified position on the first page of a document.

createInstanceMCF(XComponentContext, Class<T>, String) - Static method in class org.jodconverter.local.office.utils.Lo

Create an interface object of the given class from the given named service; uses given XComponentContext and 'new' XMultiComponentFactory so only a bridge to office is needed.

createInstanceMSF(XComponent, Class<T>, String) - Static method in class org.jodconverter.local.office.utils.Lo

Create an interface object of the given class from the given named service; uses given XComponent and 'old' XMultiServiceFactory, so a document must have been already loaded/created.

createInstanceMSF(XMultiServiceFactory, Class<T>, String) - Static method in class org.jodconverter.local.office.utils.Lo

Create an interface object of the given class from the given named service; uses given 'old' XMultiServiceFactory, so a document must have been already loaded/created.

D

DEFAULT_AFTER_START_PROCESS_DELAY - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DEFAULT_DISABLE_OPENGL - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DEFAULT_EXISTING_PROCESS_ACTION - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DEFAULT_HOSTNAME - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DEFAULT_KEEP_ALIVE_ON_SHUTDOWN - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DEFAULT_LOAD_PROPERTIES - Static variable in class org.jodconverter.local.LocalConverter

The properties which are applied by default when loading a document if not manually overridden.

DEFAULT_MAX_TASKS_PER_PROCESS - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DEFAULT_PORT - Static variable in class org.jodconverter.local.office.LocalOfficeUtils

DEFAULT_PROCESS_RETRY_INTERVAL - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DEFAULT_PROCESS_TIMEOUT - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DEFAULT_START_FAIL_FAST - Static variable in class org.jodconverter.local.office.LocalOfficeManager

DefaultFilterChain - Class in org.jodconverter.local.filter

Default implementation of FilterChain.

DefaultFilterChain() - Constructor for class org.jodconverter.local.filter.DefaultFilterChain

Creates a FilterChain without any filters that will always apply a RefreshFilter at the end of the chain.

DefaultFilterChain(Filter...) - Constructor for class org.jodconverter.local.filter.DefaultFilterChain

Creates a FilterChain that will contains the specified filters and will always apply a RefreshFilter at the end of the chain.

DefaultFilterChain(boolean) - Constructor for class org.jodconverter.local.filter.DefaultFilterChain

Creates a FilterChain without any filters.

DefaultFilterChain(boolean, Filter...) - Constructor for class org.jodconverter.local.filter.DefaultFilterChain

Creates a FilterChain that will contains the specified filters.

disableOpengl(Boolean) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies whether OpenGL must be disabled when starting a new office process.

disconnect() - Method in class org.jodconverter.local.office.OfficeConnection

Closes the connection.

disposing(EventObject) - Method in class org.jodconverter.local.office.OfficeConnection

DocumentInserterFilter - Class in org.jodconverter.local.filter.text

This filter is used to insert a document at the end of the document being converted.

DocumentInserterFilter(File) - Constructor for class org.jodconverter.local.filter.text.DocumentInserterFilter

Creates a new filter that will insert the specified document.

doFilter(OfficeContext, XComponent) - Method in class org.jodconverter.local.filter.AbstractFilterChain

doFilter(Filter, OfficeContext, XComponent) - Method in class org.jodconverter.local.filter.AbstractFilterChain

Causes the specified filter to be invoked.

doFilter(OfficeContext, XComponent) - Method in class org.jodconverter.local.filter.DefaultFilterChain

doFilter(OfficeContext, XComponent, FilterChain) - Method in interface org.jodconverter.local.filter.Filter

The doFilter method of the Filter is called each time a document is passed through the chain due to a conversion request.

doFilter(OfficeContext, XComponent) - Method in interface org.jodconverter.local.filter.FilterChain

Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, do nothing.

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.NoopFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.PageCounterFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.PagesSelectorFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.RefreshFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.text.DocumentInserterFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.text.GraphicInserterFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.text.LinkedImagesEmbedderFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.text.PageMarginsFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.text.TableOfContentUpdaterFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.text.TextInserterFilter

doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.local.filter.text.TextReplacerFilter

Draw - Class in org.jodconverter.local.office.utils

A collection of utility functions to make Office Draw documents (Drawing) easier to use.

DRAW_SERVICE - Static variable in class org.jodconverter.local.office.utils.Lo

E

execute(String[]) - Method in class org.jodconverter.local.process.AbstractProcessManager

Executes the specified command and return the output.

execute(String[]) - Method in class org.jodconverter.local.process.UnixProcessManager

execute(OfficeContext) - Method in class org.jodconverter.local.task.LocalConversionTask

ExistingProcessAction - Enum in org.jodconverter.local.office

Represents the actions that can be taken by an LocalOfficeProcessManager when trying to start an office process with a connection string and that there already is a process running with the same connection string.

existingProcessAction(ExistingProcessAction) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the action that must be taken when starting a new office process and there already is a existing running process for the same connection string.

ExitCodeRetryable - Class in org.jodconverter.local.office

Gets the exit code value of an office process.

ExitCodeRetryable(VerboseProcess) - Constructor for class org.jodconverter.local.office.ExitCodeRetryable

Creates a new instance of the class for the specified process.

ExternalOfficeManager - Class in org.jodconverter.local.office

OfficeManager implementation that uses a pool of external office processes to execute conversion tasks.

ExternalOfficeManager.Builder - Class in org.jodconverter.local.office

A builder for constructing a ExternalOfficeManager.

F

Filter - Interface in org.jodconverter.local.filter

Represents a step where a document is transformed.

FilterChain - Interface in org.jodconverter.local.filter

A FilterChain is an object that is responsible to managed an invocation chain of filters.

filterChain(Filter...) - Method in class org.jodconverter.local.LocalConverter.Builder

Specifies the filters to apply when converting a document.

filterChain(FilterChain) - Method in class org.jodconverter.local.LocalConverter.Builder

Specifies the whole filter chain to apply when converting a document.

filters - Variable in class org.jodconverter.local.filter.AbstractFilterChain

findBestProcessManager() - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Find the best process manager that will be used to retrieve a process PID and to kill a process by PID.

findPid(ProcessQuery) - Method in class org.jodconverter.local.process.AbstractProcessManager

findPid(ProcessQuery) - Method in interface org.jodconverter.local.process.ProcessManager

Finds a PID of a running process that has the specified command line.

FreeBSDProcessManager - Class in org.jodconverter.local.process

ProcessManager implementation for FreeBSD.

FreeBSDProcessManager() - Constructor for class org.jodconverter.local.process.FreeBSDProcessManager

fromExecutablePath(String) - Static method in class org.jodconverter.local.office.OfficeDescriptor

Creates descriptor from the office installation path.

fromHelpOutput(List<String>) - Static method in class org.jodconverter.local.office.OfficeDescriptor

Creates descriptor from the command line output using the help option.

G

getArgument() - Method in class org.jodconverter.local.process.ProcessQuery

Gets the arguments of the process to query.

getCalcDoc(XComponent) - Static method in class org.jodconverter.local.office.utils.Calc

Casts the given document into a XSpreadsheetDocument.

getCommand() - Method in class org.jodconverter.local.process.ProcessQuery

Gets the command of the process to query.

getComponentContext() - Method in interface org.jodconverter.local.office.LocalOfficeContext

Gets the ComponentContext interface of the remote component context.

getComponentContext() - Method in class org.jodconverter.local.office.OfficeConnection

getComponentLoader() - Method in interface org.jodconverter.local.office.LocalOfficeContext

Gets the office component loader for this context.

getComponentLoader() - Method in class org.jodconverter.local.office.OfficeConnection

getConfig(XComponentContext, String) - Static method in class org.jodconverter.local.office.utils.Info

Gets the configuration value of the specified property.

getConfig(XComponentContext, String, String) - Static method in class org.jodconverter.local.office.utils.Info

Gets the configuration value of the specified property for the specified path.

getConfigAccess(XComponentContext, String) - Static method in class org.jodconverter.local.office.utils.Info

Gets the read-only configuration access for the specified path.

getConfigProperties(XComponentContext, String) - Static method in class org.jodconverter.local.office.utils.Info

Gets the configuration properties for the specified path.

getConfigUpdateAccess(XComponentContext, String) - Static method in class org.jodconverter.local.office.utils.Info

Gets the updatable configuration access for the specified path.

getConnectString() - Method in exception org.jodconverter.local.office.OfficeConnectionException

Gets the connection strong of the connection.

getConsumer() - Method in class org.jodconverter.local.process.StreamPumper

Gets the consumer of lines read from the input stream.

getDefault() - Static method in class org.jodconverter.local.process.FreeBSDProcessManager

Gets the default instance of FreeBSDProcessManager.

getDefault() - Static method in class org.jodconverter.local.process.MacProcessManager

Gets the default instance of MacProcessManager.

getDefault() - Static method in class org.jodconverter.local.process.PureJavaProcessManager

Gets the default instance of PureJavaProcessManager.

getDefault() - Static method in class org.jodconverter.local.process.UnixProcessManager

Gets the default instance of UnixProcessManager.

getDefault() - Static method in class org.jodconverter.local.process.WindowsProcessManager

Gets the default instance of WindowsProcessManager.

getDefaultOfficeHome() - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Gets the default office home directory, which is auto-detected.

getDesktop() - Method in interface org.jodconverter.local.office.LocalOfficeContext

Gets the Desktop interface of the desktop service.

getDesktop() - Method in class org.jodconverter.local.office.OfficeConnection

getDocumentFamily(XComponent) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Gets the DocumentFamily of the specified document.

getDocumentFamilySilently(XComponent) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Gets the DocumentFamily of the specified document, without throwing an exception if not found.

getErrorPumper() - Method in class org.jodconverter.local.process.LinesPumpStreamHandler

getErrorPumper() - Method in class org.jodconverter.local.process.PumpStreamHandler

Gets the error StreamPumper.

getExitCode() - Method in class org.jodconverter.local.office.ExitCodeRetryable

The exit code of the process.

getInstance() - Static method in class org.jodconverter.local.office.utils.UnoRuntime

Gets the default UnoRuntime instance.

getLines() - Method in class org.jodconverter.local.process.LinesStreamPumper

Gets the lines read from the stream by this pumper.

getLoadProperties() - Method in class org.jodconverter.local.task.AbstractLocalOfficeTask

getOfficeExecutable(File) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Gets the office executable within an office installation.

getOfficeName(XComponentContext) - Static method in class org.jodconverter.local.office.utils.Info

Gets the office product name for the given context.

getOfficeVersionLong(XComponentContext) - Static method in class org.jodconverter.local.office.utils.Info

Gets the office product version (long representation) for the given context, e.g 6.1.0.3

getOfficeVersionShort(XComponentContext) - Static method in class org.jodconverter.local.office.utils.Info

Gets the office product version (short representation) for the given context, e.g 6.1

getOutputPumper() - Method in class org.jodconverter.local.process.LinesPumpStreamHandler

getOutputPumper() - Method in class org.jodconverter.local.process.PumpStreamHandler

Gets the output StreamPumper.

getPageCount() - Method in class org.jodconverter.local.filter.PageCounterFilter

Gets the number of pages within the document when the filter has been invoked.

getProduct() - Method in class org.jodconverter.local.office.OfficeDescriptor

Gets the product name of the office installation being used.

getProperty(Object, String) - Static method in class org.jodconverter.local.office.utils.Props

Gets a property value from the properties of the specified object.

getProperty(XPropertySet, String) - Static method in class org.jodconverter.local.office.utils.Props

Gets a property value from the specified properties.

getRectSize() - Method in class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Gets the rectangle's size of the shape that will be inserted.

getRunningProcessesCommand(String) - Method in class org.jodconverter.local.process.AbstractProcessManager

Gets the command to be executed to get a snapshot of all the running processes identified by the specified argument (process).

getRunningProcessesCommand(String) - Method in class org.jodconverter.local.process.FreeBSDProcessManager

getRunningProcessesCommand(String) - Method in class org.jodconverter.local.process.MacProcessManager

getRunningProcessesCommand(String) - Method in class org.jodconverter.local.process.UnixProcessManager

getRunningProcessesCommand(String) - Method in class org.jodconverter.local.process.WindowsProcessManager

getRunningProcessLinePattern() - Method in class org.jodconverter.local.process.AbstractProcessManager

Gets the pattern to be used to match an output line containing the information about a running process.

getRunningProcessLinePattern() - Method in class org.jodconverter.local.process.UnixProcessManager

getRunningProcessLinePattern() - Method in class org.jodconverter.local.process.WindowsProcessManager

getServiceFactory(XComponent) - Static method in class org.jodconverter.local.office.utils.Lo

Gets the XMultiServiceFactory for the given component.

getServiceManager() - Method in interface org.jodconverter.local.office.LocalOfficeContext

Gets the MultiComponentFactory interface of the remote service manager.

getServiceManager() - Method in class org.jodconverter.local.office.OfficeConnection

getShapeProperties() - Method in class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Gets the shape's properties to apply when inserting the shape to the document.

getTextDoc(XComponent) - Static method in class org.jodconverter.local.office.utils.Write

Casts the given document into a XTextDocument.

getVersion() - Method in class org.jodconverter.local.office.OfficeDescriptor

Gets the version of the office installation being used.

GraphicInserterFilter - Class in org.jodconverter.local.filter.text

This filter is used to insert a graphics into a document.

GraphicInserterFilter(String, int, int) - Constructor for class org.jodconverter.local.filter.text.GraphicInserterFilter

Creates a new filter that will insert the specified image at the specified location while converting a document.

GraphicInserterFilter(String, int, int, int, int) - Constructor for class org.jodconverter.local.filter.text.GraphicInserterFilter

Creates a new filter that will insert the specified image at the specified location while converting a document.

GraphicInserterFilter(String, Map<String, Object>) - Constructor for class org.jodconverter.local.filter.text.GraphicInserterFilter

Creates a new filter that will insert the specified image using the specified properties while converting a document.

GraphicInserterFilter(String, int, int, Map<String, Object>) - Constructor for class org.jodconverter.local.filter.text.GraphicInserterFilter

Creates a new filter that will insert the specified image using the specified properties while converting a document.

H

hostName(String) - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

Specifies host name that will be use to communicate with office.

hostName(String) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies host name that will be use in the --accept argument when starting an office process.

I

IMPRESS_SERVICE - Static variable in class org.jodconverter.local.office.utils.Lo

Info - Class in org.jodconverter.local.office.utils

A collection of utility functions to make Office info easier to get.

install() - Static method in class org.jodconverter.local.office.ExternalOfficeManager

Creates a new ExternalOfficeManager with default configuration.

install() - Static method in class org.jodconverter.local.office.LocalOfficeManager

Creates a new LocalOfficeManager with default configuration.

isCalc(XComponent) - Static method in class org.jodconverter.local.office.utils.Calc

Gets whether the given document is a Spreadsheet document.

isConnected() - Method in class org.jodconverter.local.office.OfficeConnection

Gets whether we are connected to an office instance.

isDocumentType(XComponent, String) - Static method in class org.jodconverter.local.office.utils.Info

Gets whether the given document is of the given document type.

isDraw(XComponent) - Static method in class org.jodconverter.local.office.utils.Draw

Gets whether the given document is a Draw document.

isImpress(XComponent) - Static method in class org.jodconverter.local.office.utils.Draw

Gets whether the given document is a Presentation document.

isLibreOffice(XComponentContext) - Static method in class org.jodconverter.local.office.utils.Info

Gets whether the specified context is for a LibreOffice installation.

isOpenOffice(XComponentContext) - Static method in class org.jodconverter.local.office.utils.Info

Gets whether the specified context is for an OpenOffice installation.

isText(XComponent) - Static method in class org.jodconverter.local.office.utils.Write

Gets whether the given document is a Text document.

isUsable() - Method in class org.jodconverter.local.process.WindowsProcessManager

Gets whether the commands we need are available for a Windows OS.

J

JodConverter - Class in org.jodconverter.local

Helper class that will create a LocalConverter using the previously installed OfficeManager under the hood for each conversion.

K

keepAliveOnShutdown(Boolean) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Controls whether the manager will keep the office process alive on shutdown.

kill(Process, long) - Method in interface org.jodconverter.local.process.ProcessManager

Kills the specified process.

kill(Process, long) - Method in class org.jodconverter.local.process.UnixProcessManager

kill(Process, long) - Method in class org.jodconverter.local.process.WindowsProcessManager

L

LAST_REFRESH - Static variable in class org.jodconverter.local.filter.RefreshFilter

Singleton instance of refresh filter that won't call the next filter in the chain.

LinesPumpStreamHandler - Class in org.jodconverter.local.process

Copies standard output and error of sub-processes to list of lines.

LinesPumpStreamHandler(InputStream, InputStream) - Constructor for class org.jodconverter.local.process.LinesPumpStreamHandler

Construct a new LinesPumpStreamHandler.

LinesStreamPumper - Class in org.jodconverter.local.process

Read all lines from an input stream.

LinesStreamPumper(InputStream) - Constructor for class org.jodconverter.local.process.LinesStreamPumper

Creates a new pumper for the specified stream.

LinkedImagesEmbedderFilter - Class in org.jodconverter.local.filter.text

This filter is used to insert a graphics into a document.

LinkedImagesEmbedderFilter() - Constructor for class org.jodconverter.local.filter.text.LinkedImagesEmbedderFilter

Lo - Class in org.jodconverter.local.office.utils

A collection of utility functions to make Office easier to use.

loadDocument(LocalOfficeContext, File) - Method in class org.jodconverter.local.task.AbstractLocalOfficeTask

loadProperties(Map<String, Object>) - Method in class org.jodconverter.local.LocalConverter.Builder

Specifies the load properties, for this converter, that will be applied when a document is loaded during a conversion task, regardless of the input format of the document.

loadProperties - Variable in class org.jodconverter.local.task.AbstractLocalOfficeTask

LocalConversionTask - Class in org.jodconverter.local.task

Represents the default behavior for a local conversion task.

LocalConversionTask(SourceDocumentSpecs, TargetDocumentSpecs, Map<String, Object>, FilterChain, Map<String, Object>) - Constructor for class org.jodconverter.local.task.LocalConversionTask

Creates a new conversion task from a specified source to a specified target.

LocalConverter - Class in org.jodconverter.local

Default implementation of a document converter.

LocalConverter.Builder - Class in org.jodconverter.local

A builder for constructing a LocalConverter.

LocalOfficeContext - Interface in org.jodconverter.local.office

Represents an office context for local conversions.

LocalOfficeManager - Class in org.jodconverter.local.office

Default OfficeManager implementation that uses a pool of office processes to execute conversion tasks.

LocalOfficeManager.Builder - Class in org.jodconverter.local.office

A builder for constructing a LocalOfficeManager.

LocalOfficeUtils - Class in org.jodconverter.local.office

Provides helper functions for local office.

M

MacProcessManager - Class in org.jodconverter.local.process

ProcessManager implementation for Macos.

MacProcessManager() - Constructor for class org.jodconverter.local.process.MacProcessManager

make() - Static method in class org.jodconverter.local.LocalConverter

Creates a new LocalConverter with default configuration.

make(OfficeManager) - Static method in class org.jodconverter.local.LocalConverter

Creates a new LocalConverter using the specified OfficeManager with default configuration.

make() - Static method in class org.jodconverter.local.office.ExternalOfficeManager

Creates a new ExternalOfficeManager with default configuration.

make() - Static method in class org.jodconverter.local.office.LocalOfficeManager

Creates a new LocalOfficeManager with default configuration.

makeProperties(String, Object) - Static method in class org.jodconverter.local.office.utils.Props

Creates an array of PropertyValue with a single property using the specified property name and value.

makeProperties(String, Object, String, Object) - Static method in class org.jodconverter.local.office.utils.Props

Creates an array of PropertyValue with 2 properties using the specified property names and values.

makeProperties(String[], Object[]) - Static method in class org.jodconverter.local.office.utils.Props

Creates an array of PropertyValue with properties using the specified property names and values.

makeProperty(String, Object) - Static method in class org.jodconverter.local.office.utils.Props

Creates a PropertyValue with the specified name and value.

MAX_AFTER_START_PROCESS_DELAY - Static variable in class org.jodconverter.local.office.LocalOfficeManager

MAX_PROCESS_RETRY_INTERVAL - Static variable in class org.jodconverter.local.office.LocalOfficeManager

maxTasksPerConnection(Integer) - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

Specifies the maximum number of tasks an office process can execute before reconnecting to it.

maxTasksPerProcess(Integer) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the maximum number of tasks an office process can execute before restarting.

MIN_AFTER_START_PROCESS_DELAY - Static variable in class org.jodconverter.local.office.LocalOfficeManager

MIN_PROCESS_RETRY_INTERVAL - Static variable in class org.jodconverter.local.office.LocalOfficeManager

modifyDocument(OfficeContext, XComponent) - Method in class org.jodconverter.local.task.LocalConversionTask

N

NOOP - Static variable in class org.jodconverter.local.filter.NoopFilter

Singleton instance of refresh filter that won't call the next filter in the chain.

NoopFilter - Class in org.jodconverter.local.filter

This filter does nothing except calling the next filter in the chain.

NoopFilter() - Constructor for class org.jodconverter.local.filter.NoopFilter

O

OfficeConnection - Class in org.jodconverter.local.office

An OfficeConnection is responsible to manage the connection to an office process using a given UnoUrl.

OfficeConnection(OfficeUrl) - Constructor for class org.jodconverter.local.office.OfficeConnection

Constructs a new connection for the specified UNO URL.

OfficeConnectionException - Exception in org.jodconverter.local.office

Exceptions thrown when a connection to an office process failed.

OfficeConnectionException(String, String) - Constructor for exception org.jodconverter.local.office.OfficeConnectionException

Constructs a new connect exception with the specified detail message.

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

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

OfficeDescriptor - Class in org.jodconverter.local.office

Contains basic information about the office installation being used.

officeHome(File) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the office home directory (office installation).

officeHome(String) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the office home directory (office installation).

org.jodconverter.local - package org.jodconverter.local

This package provides the DocumentConverter implementation of the JODConverter local module, which is the LocalConverter class.

org.jodconverter.local.filter - package org.jodconverter.local.filter

This package contains classes related to the modification of a document after it has been loaded by JODConverter.

org.jodconverter.local.filter.text - package org.jodconverter.local.filter.text

This package provides various Filter implementations that can be used while converting a document from the TEXT document family.

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

This package contains interfaces/classes related to local office management, such as the start/stop of an office instance, office instances pool management, etc.

org.jodconverter.local.office.utils - package org.jodconverter.local.office.utils

This package contains helper classes that can ne used to interact with a running office instance.

org.jodconverter.local.process - package org.jodconverter.local.process

This package provides various ProcessManager implementations for dealing with office processes (kill processes, retrieve process ids, etc.).

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

This package contains the classes related to local conversion tasks.

P

PageCounterFilter - Class in org.jodconverter.local.filter

This filter is used to count the number of pages of a document.

PageCounterFilter() - Constructor for class org.jodconverter.local.filter.PageCounterFilter

PageMarginsFilter - Class in org.jodconverter.local.filter.text

This filter is used to set the margins of the document being converted.

PageMarginsFilter(Integer, Integer, Integer, Integer) - Constructor for class org.jodconverter.local.filter.text.PageMarginsFilter

Creates a new filter that will set the margins of the document.

PagesSelectorFilter - Class in org.jodconverter.local.filter

This filter is used to select specific pages from a document in order to convert only the selected pages.

PagesSelectorFilter(Integer...) - Constructor for class org.jodconverter.local.filter.PagesSelectorFilter

Creates a new filter that will select the specified pages while converting a document (only the given pages will be converted).

PagesSelectorFilter(Set<Integer>) - Constructor for class org.jodconverter.local.filter.PagesSelectorFilter

Creates a new filter that will select the specified pages while converting a document (only the given pages will be converted).

PID_NOT_FOUND - Static variable in interface org.jodconverter.local.process.ProcessManager

PID_UNKNOWN - Static variable in interface org.jodconverter.local.process.ProcessManager

pipeNames(String...) - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

Specifies the pipe names that will be use to communicate with office.

pipeNames(String...) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the pipe names that will be use to communicate with office.

portNumbers(int...) - Method in class org.jodconverter.local.office.ExternalOfficeManager.Builder

Specifies the port numbers that will be use to communicate with office.

portNumbers(int...) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the port numbers that will be use to communicate with office.

pos - Variable in class org.jodconverter.local.filter.AbstractFilterChain

processManager(ProcessManager) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Provides a specific ProcessManager implementation to be used when dealing with an office process (retrieve PID, kill process).

processManager(String) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Provides a custom ProcessManager implementation, which may not be included in the standard JODConverter distribution.

ProcessManager - Interface in org.jodconverter.local.process

Provides services required to manage a running process.

ProcessQuery - Class in org.jodconverter.local.process

Contains the required information used to query for a running process.

ProcessQuery(String, String) - Constructor for class org.jodconverter.local.process.ProcessQuery

Constructs a new instance with the given command and argument.

processRetryInterval(Long) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the delay, in milliseconds, between each try when trying to execute an office process call (start/terminate).

processTimeout(Long) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the timeout, in milliseconds, when trying to execute an office process call (start/terminate).

Props - Class in org.jodconverter.local.office.utils

A collection of utility functions to make Office properties easier to use.

PumpStreamHandler - Class in org.jodconverter.local.process

Copies standard output and error of sub-processes to given stream pumpers.

PumpStreamHandler(StreamPumper, StreamPumper) - Constructor for class org.jodconverter.local.process.PumpStreamHandler

Construct a new PumpStreamHandler.

PureJavaProcessManager - Class in org.jodconverter.local.process

ProcessManager implementation for Java.

PureJavaProcessManager() - Constructor for class org.jodconverter.local.process.PureJavaProcessManager

Q

qi(Class<T>, Object) - Static method in class org.jodconverter.local.office.utils.Lo

Queries the given UNO object for the given Java class (which must represent a UNO interface type).

qiOptional(Class<T>, Object) - Static method in class org.jodconverter.local.office.utils.Lo

Queries the given UNO object for the given Java class (which must represent a UNO interface type).

queryInterface(Class<T>, Object) - Method in class org.jodconverter.local.office.utils.UnoRuntime

Queries the given UNO object for the given Java class (which must represent a UNO interface type).

R

REFRESH - Static variable in class org.jodconverter.local.filter.RefreshFilter

Singleton instance of refresh filter that will call the next filter in the chain.

RefreshFilter - Class in org.jodconverter.local.filter

This filter is used to refresh a document.

RefreshFilter() - Constructor for class org.jodconverter.local.filter.RefreshFilter

Creates a new refresh filter.

RefreshFilter(boolean) - Constructor for class org.jodconverter.local.filter.RefreshFilter

Creates a new refresh filter that will call or not the next filter in the chain according to the specified argument.

reset() - Method in class org.jodconverter.local.filter.AbstractFilterChain

Resets the position in the filter chain to 0, making the chain reusable.

run() - Method in class org.jodconverter.local.process.StreamPumper

runAsArgs(String...) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the sudo arguments that will be used with unix commands.

S

setInstance(UnoRuntime) - Static method in class org.jodconverter.local.office.utils.UnoRuntime

Sets the default UnoRuntime instance.

setRectSize(Dimension) - Method in class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Sets the rectangle's size of the shape that will be inserted.

setRunAsArgs(String[]) - Method in class org.jodconverter.local.process.UnixProcessManager

Sets The sudo command arguments.

start() - Method in class org.jodconverter.local.process.PumpStreamHandler

Start the pumpers.

startFailFast(Boolean) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Controls whether the manager will "fail fast" if an office process cannot be started or the connection to the started process fails.

stop() - Method in class org.jodconverter.local.process.PumpStreamHandler

Stop pumping the streams.

StopProcessAction - Enum in org.jodconverter.local.office

Represents the actions that can be taken by an LocalOfficeProcessManager when trying to start an office process with a connection string and that there already is a process running with the same connection string.

storeDocument(XComponent, File) - Method in class org.jodconverter.local.task.LocalConversionTask

storeProperties(Map<String, Object>) - Method in class org.jodconverter.local.LocalConverter.Builder

Specifies the properties that will be applied when a document is stored during the conversion task.

StreamPumper - Class in org.jodconverter.local.process

Read all lines from an input stream.

StreamPumper(InputStream, StreamPumper.LineConsumer) - Constructor for class org.jodconverter.local.process.StreamPumper

Creates a new pumper for the specified stream.

StreamPumper.LineConsumer - Interface in org.jodconverter.local.process

Provides a function to consume a line read from a stream.

T

TableOfContentUpdaterFilter - Class in org.jodconverter.local.filter.text

This filter update all indexes in a document.

TableOfContentUpdaterFilter() - Constructor for class org.jodconverter.local.filter.text.TableOfContentUpdaterFilter

Creates a new filter that will update the table of content.

TableOfContentUpdaterFilter(int) - Constructor for class org.jodconverter.local.filter.text.TableOfContentUpdaterFilter

Creates a new filter that will change the number of levels of the table of content and will update it.

templateProfileDir(File) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the directory to copy to the temporary office profile directories to be created.

templateProfileDir(String) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the directory to copy to the temporary office profile directories to be created.

templateProfileDirOrDefault(File) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the directory to copy to the temporary office profile directories to be created.

templateProfileDirOrDefault(String) - Method in class org.jodconverter.local.office.LocalOfficeManager.Builder

Specifies the directory to copy to the temporary office profile directories to be created.

TextInserterFilter - Class in org.jodconverter.local.filter.text

This filter is used to insert text into a document.

TextInserterFilter(String, int, int, int, int) - Constructor for class org.jodconverter.local.filter.text.TextInserterFilter

Creates a new filter that will insert the specified text at the specified location while converting a document.

TextInserterFilter(String, int, int, Map<String, Object>) - Constructor for class org.jodconverter.local.filter.text.TextInserterFilter

Creates a new filter that will insert the specified text at the specified location while converting a document.

TextReplacerFilter - Class in org.jodconverter.local.filter.text

This filter is used to replace text in a document.

TextReplacerFilter(String[], String[]) - Constructor for class org.jodconverter.local.filter.text.TextReplacerFilter

Creates a new filter with the specified strings to replace.

toOfficeSize(Dimension) - Static method in class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

Converts the specified size where units are millimeters to an office size where unit are 1/100 millimeters.

toString() - Method in class org.jodconverter.local.office.OfficeDescriptor

toString() - Method in class org.jodconverter.local.process.ProcessQuery

toString() - Method in class org.jodconverter.local.task.AbstractLocalOfficeTask

toString() - Method in class org.jodconverter.local.task.LocalConversionTask

toUnoProperties(Map<String, Object>) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Converts a regular java map to an array of PropertyValue, usable as arguments with UNO interface types.

toUrl(File) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Constructs an URL from the specified file as expected by office.

U

UnixProcessManager - Class in org.jodconverter.local.process

ProcessManager implementation for *nix systems.

UnixProcessManager() - Constructor for class org.jodconverter.local.process.UnixProcessManager

UnmodifiableFilterChain - Class in org.jodconverter.local.filter

Unmodifiable implementation of FilterChain.

UnmodifiableFilterChain(Filter...) - Constructor for class org.jodconverter.local.filter.UnmodifiableFilterChain

Creates an unmodifiable FilterChain that will contains the specified filters.

UnoRuntime - Class in org.jodconverter.local.office.utils

The purpose of this class is to provide a single access point to the UnoRuntime class, making the mocking of the class possible.

UnoRuntime() - Constructor for class org.jodconverter.local.office.utils.UnoRuntime

useLongOptionNameGnuStyle() - Method in class org.jodconverter.local.office.OfficeDescriptor

Gets whether we must use the lone option name GNU style (--) when setting command line options to start an office instance.

V

validateOfficeHome(File) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Validates that the specified File instance is a valid office home directory.

validateOfficeTemplateProfileDirectory(File) - Static method in class org.jodconverter.local.office.LocalOfficeUtils

Validates that the specified File instance is a valid office template profile directory.

valueOf(String) - Static method in enum org.jodconverter.local.office.ExistingProcessAction

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

valueOf(String) - Static method in enum org.jodconverter.local.office.StopProcessAction

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

values() - Static method in enum org.jodconverter.local.office.ExistingProcessAction

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

values() - Static method in enum org.jodconverter.local.office.StopProcessAction

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

W

WindowsProcessManager - Class in org.jodconverter.local.process

ProcessManager implementation for Windows.

WindowsProcessManager() - Constructor for class org.jodconverter.local.process.WindowsProcessManager

WrappedUnoException - Exception in org.jodconverter.local.office.utils

This is an exception that wraps a checked exception thrown by office.

WrappedUnoException(String, Exception) - Constructor for exception org.jodconverter.local.office.utils.WrappedUnoException

Constructs a new exception with the specified detail message and wrapped exception.

WrappedUnoException(Exception) - Constructor for exception org.jodconverter.local.office.utils.WrappedUnoException

Constructs a new exception with the specified wrapped exception.

Write - Class in org.jodconverter.local.office.utils

A collection of utility functions to make Office Text documents (Writer) easier to use.

WRITER_SERVICE - Static variable in class org.jodconverter.local.office.utils.Lo

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