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

A

AbstractFilterChain - Class in org.jodconverter.filter
Base class of a FilterChain.
AbstractFilterChain() - Constructor for class org.jodconverter.filter.AbstractFilterChain
Creates a FilterChain.
AbstractFilterChain(Filter...) - Constructor for class org.jodconverter.filter.AbstractFilterChain
Creates a FilterChain that will contains the specified filters.
AbstractFilterChain(boolean, Filter...) - Constructor for class org.jodconverter.filter.AbstractFilterChain
Creates a FilterChain that will contains the specified filters.
AbstractLocalOfficeTask - Class in org.jodconverter.task
Base class for all local office tasks implementation.
AbstractLocalOfficeTask(SourceDocumentSpecs) - Constructor for class org.jodconverter.task.AbstractLocalOfficeTask
Creates a new task with the specified source document.
AbstractLocalOfficeTask(SourceDocumentSpecs, Map<String, Object>) - Constructor for class org.jodconverter.task.AbstractLocalOfficeTask
Creates a new task with the specified source document.
AbstractProcessManager - Class in org.jodconverter.process
Base class for all process manager implementations included in the standard JODConverter distribution.
AbstractProcessManager() - Constructor for class org.jodconverter.process.AbstractProcessManager
Initializes a new instance of the class.
AbstractTextContentInserterFilter - Class in org.jodconverter.filter.text
Base class for all filter used to insert a TextContent into a document.
AbstractTextContentInserterFilter(Dimension, int, int) - Constructor for class org.jodconverter.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.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.
addFilter(Filter) - Method in class org.jodconverter.filter.AbstractFilterChain
Adds a filter to the chain.
addFilter(Filter) - Method in interface org.jodconverter.filter.FilterChain
Adds a filter to the chain.
addPropertiesToMap(Map<String, Object>, Map<String, Object>) - Static method in class org.jodconverter.task.AbstractLocalOfficeTask
 
applyAnchorPageNoFix(XTextDocument, XTextCursor) - Method in class org.jodconverter.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.office.ConnectRetryable
 
attempt() - Method in class org.jodconverter.office.ExitCodeRetryable
 

B

build() - Method in class org.jodconverter.LocalConverter.Builder
Creates the converter that is specified by this builder.
build() - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Builds a ProcessPoolOfficeManager with the current configuration.
build() - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
Builds a new ExternalOfficeManager.
build() - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Creates the converter that is specified by this builder.
builder() - Static method in class org.jodconverter.LocalConverter
Creates a new builder instance.
builder() - Static method in class org.jodconverter.office.LocalOfficeManager
Creates a new builder instance.
buildOfficeUrls(int[], String[]) - Static method in class org.jodconverter.office.LocalOfficeUtils
Builds an array of OfficeUrl from an array of port numbers and an array of pipe names.

C

CHAIN - Static variable in class org.jodconverter.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.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.task.AbstractLocalOfficeTask
 
ConnectRetryable - Class in org.jodconverter.office
Performs a connection to an office process.
ConnectRetryable(OfficeConnection) - Constructor for class org.jodconverter.office.ConnectRetryable
Creates a new instance of the class for the specified connection.
ConnectRetryable(OfficeProcess, OfficeConnection) - Constructor for class org.jodconverter.office.ConnectRetryable
Creates a new instance of the class for the specified process and connection.
convert(File) - Static method in class org.jodconverter.JodConverter
Converts a source file that is stored on the local file system.
convert(InputStream) - Static method in class org.jodconverter.JodConverter
Converts a source stream input stream.
convert(InputStream, boolean) - Static method in class org.jodconverter.JodConverter
Converts a source stream input stream.
convert(AbstractSourceDocumentSpecs) - Method in class org.jodconverter.LocalConverter
 
convert(File, File) - Method in class org.jodconverter.OfficeDocumentConverter
Converts an input file to an output file.
convert(File, File, DocumentFormat) - Method in class org.jodconverter.OfficeDocumentConverter
Converts an input file to an output file.
convert(File, File, DocumentFormat, DocumentFormat) - Method in class org.jodconverter.OfficeDocumentConverter
Converts an input file to an output file.
convert(FilterChain, File, File) - Method in class org.jodconverter.OfficeDocumentConverter
Converts an input file to an output file.
convert(FilterChain, File, File, DocumentFormat) - Method in class org.jodconverter.OfficeDocumentConverter
Converts an input file to an output file.
convert(FilterChain, File, File, DocumentFormat, DocumentFormat) - Method in class org.jodconverter.OfficeDocumentConverter
Converts an input file to an output file.
createDefaultShapeProperties(int, int) - Static method in class org.jodconverter.filter.text.AbstractTextContentInserterFilter
Creates the default shape properties that would insert text content at the specified position on the first page of a document.
createPoolEntries() - Method in class org.jodconverter.office.LocalOfficeManager
 

D

DEFAULT_LOAD_PROPERTIES - Static variable in class org.jodconverter.task.AbstractLocalOfficeTask
 
DefaultFilterChain - Class in org.jodconverter.filter
Default implementation of FilterChain.
DefaultFilterChain() - Constructor for class org.jodconverter.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.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.filter.DefaultFilterChain
Creates a FilterChain without any filters.
DefaultFilterChain(boolean, Filter...) - Constructor for class org.jodconverter.filter.DefaultFilterChain
Creates a FilterChain that will contains the specified filters.
DefaultOfficeManagerBuilder - Class in org.jodconverter.office
Deprecated.
DefaultOfficeManagerBuilder() - Constructor for class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
 
disableOpengl(boolean) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies whether OpenGL must be disabled when starting a new office process.
doFilter(OfficeContext, XComponent) - Method in class org.jodconverter.filter.AbstractFilterChain
 
doFilter(Filter, OfficeContext, XComponent) - Method in class org.jodconverter.filter.AbstractFilterChain
Causes the specified filter to be invoked.
doFilter(OfficeContext, XComponent) - Method in class org.jodconverter.filter.DefaultFilterChain
 
doFilter(OfficeContext, XComponent, FilterChain) - Method in interface org.jodconverter.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.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.filter.NoopFilter
 
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.RefreshFilter
 
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.GraphicInserterFilter
 
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.PageCounterFilter
 
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.PageSelectorFilter
 
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.TableOfContentUpdaterFilter
 
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.TextInserterFilter
 
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.TextReplacerFilter
 

E

execute(String[]) - Method in class org.jodconverter.process.AbstractProcessManager
Executes the specified command and return the output.
execute(String[]) - Method in class org.jodconverter.process.UnixProcessManager
 
execute(OfficeContext) - Method in class org.jodconverter.task.LocalConversionTask
 
ExitCodeRetryable - Class in org.jodconverter.office
Gets the exit code value of an office process.
ExitCodeRetryable(Process) - Constructor for class org.jodconverter.office.ExitCodeRetryable
Creates a new instance of the class for the specified process.
ExternalOfficeManagerBuilder - Class in org.jodconverter.office
Helper class used to creates ExternalOfficeManager instances.
ExternalOfficeManagerBuilder() - Constructor for class org.jodconverter.office.ExternalOfficeManagerBuilder
 

F

Filter - Interface in org.jodconverter.filter
Represents a step where a document is transformed.
FilterChain - Interface in org.jodconverter.filter
A FilterChain is an object that is responsible to managed an invocation chain of filters.
filterChain(Filter...) - Method in class org.jodconverter.LocalConverter.Builder
Specifies the filters to apply when converting a document.
filterChain(FilterChain) - Method in class org.jodconverter.LocalConverter.Builder
Specifies the whole filter chain to apply when converting a document.
filters - Variable in class org.jodconverter.filter.AbstractFilterChain
 
findBestProcessManager() - Static method in class org.jodconverter.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.process.AbstractProcessManager
 
findPid(ProcessQuery) - Method in interface org.jodconverter.process.ProcessManager
Finds a PID of a running process that has the specified command line.
findPid(ProcessQuery) - Method in class org.jodconverter.process.PureJavaProcessManager
 

G

getArgument() - Method in class org.jodconverter.process.ProcessQuery
Gets the arguments of the process to query.
getCommand() - Method in class org.jodconverter.process.ProcessQuery
Gets the command of the process to query.
getComponentContext() - Method in interface org.jodconverter.office.LocalOfficeContext
Gets the office component context for this context.
getComponentLoader() - Method in interface org.jodconverter.office.LocalOfficeContext
Gets the office component loader for this context.
getConnection() - Method in class org.jodconverter.office.OfficeUrl
Returns the name of the connection of this Uno Url.
getConnectionAndParametersAsString() - Method in class org.jodconverter.office.OfficeUrl
Returns the raw specification of the connection name and parameters.
getConnectionParameters() - Method in class org.jodconverter.office.OfficeUrl
Returns the connection parameters as a map with key/value pairs.
getConnectionParametersAsString() - Method in class org.jodconverter.office.OfficeUrl
Returns the raw specification of the connection parameters.
getConnectString() - Method in exception org.jodconverter.office.OfficeConnectionException
Gets the connection strong of the connection.
getDefault() - Static method in class org.jodconverter.process.MacProcessManager
Gets the default instance of MacProcessManager.
getDefault() - Static method in class org.jodconverter.process.PureJavaProcessManager
Gets the default instance of PureJavaProcessManager.
getDefault() - Static method in class org.jodconverter.process.UnixProcessManager
Gets the default instance of UnixProcessManager.
getDefault() - Static method in class org.jodconverter.process.WindowsProcessManager
Gets the default instance of WindowsProcessManager.
getDefaultOfficeHome() - Static method in class org.jodconverter.office.LocalOfficeUtils
Gets the default office home directory, which is auto-detected.
getDesktop() - Method in interface org.jodconverter.office.LocalOfficeContext
Gets the office desktop for this context.
getExitCode() - Method in class org.jodconverter.office.ExitCodeRetryable
The exit code of the process.
getFormatRegistry() - Method in class org.jodconverter.OfficeDocumentConverter
Gets all the DocumentFormat supported by the converter.
getLoadProperties() - Method in class org.jodconverter.task.AbstractLocalOfficeTask
 
getOfficeExecutable(File) - Static method in class org.jodconverter.office.LocalOfficeUtils
Gets the office executable within an office installation.
getPageCount() - Method in class org.jodconverter.filter.text.PageCounterFilter
Gets the number of pages within the document when the filter has been invoked.
getProtocol() - Method in class org.jodconverter.office.OfficeUrl
Returns the name of the protocol of this Uno Url.
getProtocolAndParametersAsString() - Method in class org.jodconverter.office.OfficeUrl
Returns the raw specification of the protocol name and parameters.
getProtocolParameters() - Method in class org.jodconverter.office.OfficeUrl
Returns the protocol parameters as a map with key/value pairs.
getProtocolParametersAsString() - Method in class org.jodconverter.office.OfficeUrl
Returns the raw specification of the protocol parameters.
getRectSize() - Method in class org.jodconverter.filter.text.AbstractTextContentInserterFilter
Gets the rectangle's size of the shape that will be inserted.
getRootOid() - Method in class org.jodconverter.office.OfficeUrl
Return the object name.
getRunningProcessesCommand(String) - Method in class org.jodconverter.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.process.MacProcessManager
 
getRunningProcessesCommand(String) - Method in class org.jodconverter.process.UnixProcessManager
 
getRunningProcessesCommand(String) - Method in class org.jodconverter.process.WindowsProcessManager
 
getRunningProcessLinePattern() - Method in class org.jodconverter.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.process.UnixProcessManager
 
getRunningProcessLinePattern() - Method in class org.jodconverter.process.WindowsProcessManager
 
getShapeProperties() - Method in class org.jodconverter.filter.text.AbstractTextContentInserterFilter
Gets the shape's properties to apply when inserting the shape to the document.
GraphicInserterFilter - Class in org.jodconverter.filter.text
This filter is used to insert a graphics into a document.
GraphicInserterFilter(String, int, int) - Constructor for class org.jodconverter.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.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, Map<String, Object>) - Constructor for class org.jodconverter.filter.text.GraphicInserterFilter
Creates a new filter that will insert the specified image using the specified properties while converting a document.
GraphicInserterFilter(String, Map<String, Object>) - Constructor for class org.jodconverter.filter.text.GraphicInserterFilter
Creates a new filter that will insert the specified image using the specified properties while converting a document.

I

install() - Static method in class org.jodconverter.office.LocalOfficeManager
Creates a new LocalOfficeManager with default configuration.
INSTANCE - Static variable in class org.jodconverter.filter.RefreshFilter
Deprecated.
isUsable() - Method in class org.jodconverter.process.WindowsProcessManager
Gets whether the commands we need are available for a Windows OS.

J

JodConverter - Class in org.jodconverter
Helper class that will create a LocalConverter using the previously installed OfficeManager under the hood for each conversion.

K

kill(Process, long) - Method in interface org.jodconverter.process.ProcessManager
Kills the specified process.
kill(Process, long) - Method in class org.jodconverter.process.PureJavaProcessManager
 
kill(Process, long) - Method in class org.jodconverter.process.UnixProcessManager
 
kill(Process, long) - Method in class org.jodconverter.process.WindowsProcessManager
 
killExistingProcess(boolean) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies whether an existing office process is killed when starting a new office process for the same connection string.

L

LAST_REFRESH - Static variable in class org.jodconverter.filter.RefreshFilter
Singleton instance of refresh filter that won't call the next filter in the chain.
loadDocument(LocalOfficeContext, File) - Method in class org.jodconverter.task.AbstractLocalOfficeTask
 
loadProperties(Map<String, Object>) - Method in class org.jodconverter.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.task.AbstractLocalOfficeTask
 
LocalConversionTask - Class in org.jodconverter.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.task.LocalConversionTask
Creates a new conversion task from a specified source to a specified target.
LocalConverter - Class in org.jodconverter
Default implementation of a document converter.
LocalConverter.Builder - Class in org.jodconverter
A builder for constructing a LocalConverter.
LocalOfficeContext - Interface in org.jodconverter.office
Represents an office context for local conversions.
LocalOfficeManager - Class in org.jodconverter.office
Default OfficeManager implementation that uses a pool of office processes to execute conversion tasks.
LocalOfficeManager.Builder - Class in org.jodconverter.office
A builder for constructing a LocalOfficeManager.
LocalOfficeUtils - Class in org.jodconverter.office
 

M

MacProcessManager - Class in org.jodconverter.process
 
MacProcessManager() - Constructor for class org.jodconverter.process.MacProcessManager
 
make() - Static method in class org.jodconverter.LocalConverter
Creates a new LocalConverter using with default configuration.
make(OfficeManager) - Static method in class org.jodconverter.LocalConverter
Creates a new LocalConverter using the specified OfficeManager with default configuration.
make() - Static method in class org.jodconverter.office.LocalOfficeManager
Creates a new LocalOfficeManager with default configuration.
maxTasksPerProcess(int) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies the maximum number of tasks an office process can execute before restarting.

N

NOOP - Static variable in class org.jodconverter.filter.NoopFilter
Singleton instance of refresh filter that won't call the next filter in the chain.
NoopFilter - Class in org.jodconverter.filter
This filter does nothing except calling the next filter in the chain.
NoopFilter() - Constructor for class org.jodconverter.filter.NoopFilter
 

O

OfficeConnectionException - Exception in org.jodconverter.office
Exceptions thrown when a connection to an office process failed.
OfficeConnectionException(String, String) - Constructor for exception org.jodconverter.office.OfficeConnectionException
Constructs a new connect exception with the specified detail message.
OfficeConnectionException(String, String, Throwable) - Constructor for exception org.jodconverter.office.OfficeConnectionException
Constructs a new connect exception with the specified detail message and cause.
OfficeConnectionProtocol - Enum in org.jodconverter.office
Represents protocols that can be used to communicate with a running office instance.
OfficeDocumentConverter - Class in org.jodconverter
A OfficeDocumentConverter is responsible to execute the conversion of documents using an office manager.
OfficeDocumentConverter(OfficeManager) - Constructor for class org.jodconverter.OfficeDocumentConverter
Constructs a new instance of the class with the specified manager.
OfficeDocumentConverter(OfficeManager, DocumentFormatRegistry) - Constructor for class org.jodconverter.OfficeDocumentConverter
Constructs a new instance of the class with the specified manager and registry.
officeHome(File) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies the office home directory (office installation).
officeHome(String) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies the office home directory (office installation).
OfficeUrl - Class in org.jodconverter.office
Wrapper class around an UnoUrl so we are not importing the com.sun.star.lib.uno.helper.UnoUrl package everywhere.
OfficeUrl(String) - Constructor for class org.jodconverter.office.OfficeUrl
Creates an OfficeUrl for the specified pipe.
OfficeUrl(int) - Constructor for class org.jodconverter.office.OfficeUrl
Creates an OfficeUrl for the specified port.
org.jodconverter - package org.jodconverter
This package contains the interfaces/classes related to the tasks an office process can execute.
org.jodconverter.filter - package org.jodconverter.filter
This package contains classes related to the modification of a document after it has been loaded by JODConverter.
org.jodconverter.filter.text - package org.jodconverter.filter.text
This package provides various Filter implementations that can be used while converting a document from the TEXT document family.
org.jodconverter.office - package org.jodconverter.office
 
org.jodconverter.process - package org.jodconverter.process
This package provides various ProcessManager implementations for dealing with office processes (kill processes, retrieve process ids, etc.).
org.jodconverter.task - package org.jodconverter.task
 

P

PageCounterFilter - Class in org.jodconverter.filter.text
This filter is used to count the number of pages of a document.
PageCounterFilter() - Constructor for class org.jodconverter.filter.text.PageCounterFilter
 
PageSelectorFilter - Class in org.jodconverter.filter.text
This filter is used to select a specific page from a document in order to convert only the selected page.
PageSelectorFilter(int) - Constructor for class org.jodconverter.filter.text.PageSelectorFilter
Creates a new filter that will select the specified page while converting a document (only the given page will be converted).
PID_NOT_FOUND - Static variable in interface org.jodconverter.process.ProcessManager
 
PID_UNKNOWN - Static variable in interface org.jodconverter.process.ProcessManager
 
pipeNames(String...) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies the pipe names that will be use to communicate with office.
portNumbers(int...) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies the port numbers that will be use to communicate with office.
pos - Variable in class org.jodconverter.filter.AbstractFilterChain
 
processManager(ProcessManager) - Method in class org.jodconverter.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.office.LocalOfficeManager.Builder
Provides a custom ProcessManager implementation, which may not be included in the standard JODConverter distribution.
ProcessManager - Interface in org.jodconverter.process
Provides services required to manage a running process.
ProcessQuery - Class in org.jodconverter.process
Contains the required information used to query for a running process.
ProcessQuery(String, String) - Constructor for class org.jodconverter.process.ProcessQuery
Constructs a new instance with the given command and argument.
processRetryInterval(long) - Method in class org.jodconverter.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.office.LocalOfficeManager.Builder
Specifies the timeout, in milliseconds, when trying to execute an office process call (start/terminate).
property(String, Object) - Static method in class org.jodconverter.office.LocalOfficeUtils
Creates a PropertyValue with the specified name and value.
PureJavaProcessManager - Class in org.jodconverter.process
 
PureJavaProcessManager() - Constructor for class org.jodconverter.process.PureJavaProcessManager
 

R

RefreshFilter - Class in org.jodconverter.filter
This filter is used to refresh a document.
RefreshFilter() - Constructor for class org.jodconverter.filter.RefreshFilter
Creates a new refresh filter.
RefreshFilter(boolean) - Constructor for class org.jodconverter.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.filter.AbstractFilterChain
Resets the position in the filter chain to 0, making the chain reusable.
runAsArgs(String...) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies the sudo arguments that will be used with unix commands.

S

setConnectionProtocol(OfficeConnectionProtocol) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Sets the connection protocol.
setConnectionProtocol(OfficeConnectionProtocol) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
Sets the connection protocol.
setConnectOnStart(boolean) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
Sets whether a connection is attempted on start.
setConnectTimeout(long) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
Sets the timeout after which a connection attempt will fail.
setDefaultLoadProperties(Map<String, Object>) - Method in class org.jodconverter.OfficeDocumentConverter
Sets the default properties to use when we load (open) a document before a conversion, regardless the input type of the document.
setKillExistingProcess(boolean) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies if an existing office process is killed when starting a new office process for the same connection string.
setMaxTasksPerProcess(int) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the maximum number of tasks an office process can execute before restarting.
setOfficeHome(File) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the office home directory (office installation).
setOfficeHome(String) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the office home directory (office installation).
setPipeName(String) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
Sets the pipe name that will be use to communicate with office.
setPipeNames(String...) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the pipe names that will be use to communicate with office.
setPortNumber(int) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
Sets the port number that will be use to communicate with office.
setPortNumbers(int...) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the port numbers that will be use to communicate with office.
setProcessManager(ProcessManager) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Provides a specific ProcessManager implementation to be used when dealing with an office process (retrieve PID, kill process).
setProcessManager(String) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Provides a custom ProcessManager implementation, which may not be included in the standard JODConverter distribution.
setRetryInterval(long) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
setRetryTimeout(long) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
setRunAsArgs(String...) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the sudo arguments that will be used with unix commands.
setRunAsArgs(String[]) - Method in class org.jodconverter.process.UnixProcessManager
Sets The sudo command arguments.
setTaskExecutionTimeout(long) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the maximum time allowed to process a task.
setTaskQueueTimeout(long) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the maximum living time of a task in the conversion queue.
setTemplateProfileDir(File) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the directory to copy to the temporary office profile directories to be created.
setTemplateProfileDir(String) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the directory to copy to the temporary office profile directories to be created.
setWorkingDir(File) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the directory where temporary office profile directories will be created.
setWorkingDir(String) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
Deprecated.
Specifies the directory where temporary office profile directories will be created.
stopQuietly(OfficeManager) - Static method in class org.jodconverter.office.LocalOfficeUtils
Stops an OfficeManager unconditionally.
storeProperties(Map<String, Object>) - Method in class org.jodconverter.LocalConverter.Builder
Specifies the properties that will be applied when a document is stored during the conversion task.

T

TableOfContentUpdaterFilter - Class in org.jodconverter.filter.text
This filter update all indexes in a document.
TableOfContentUpdaterFilter() - Constructor for class org.jodconverter.filter.text.TableOfContentUpdaterFilter
Creates a new filter that will update the table of content.
TableOfContentUpdaterFilter(int) - Constructor for class org.jodconverter.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.office.LocalOfficeManager.Builder
Specifies the directory to copy to the temporary office profile directories to be created.
templateProfileDir(String) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
Specifies the directory to copy to the temporary office profile directories to be created.
TextInserterFilter - Class in org.jodconverter.filter.text
This filter is used to insert text into a document.
TextInserterFilter(String, int, int, int, int) - Constructor for class org.jodconverter.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.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.filter.text
This filter is used to replace text in a document.
TextReplacerFilter(String[], String[]) - Constructor for class org.jodconverter.filter.text.TextReplacerFilter
Creates a new filter with the specified strings to replace.
toOfficeSize(Dimension) - Static method in class org.jodconverter.filter.text.AbstractTextContentInserterFilter
Converts the specified size where units are millimeters to an office size where unit are 1/100 millimeters.
toUnoProperties(Map<String, Object>) - Static method in class org.jodconverter.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.office.LocalOfficeUtils
Constructs an URL from the specified file as expected by office.

U

UnixProcessManager - Class in org.jodconverter.process
ProcessManager implementation for *nix systems.
UnixProcessManager() - Constructor for class org.jodconverter.process.UnixProcessManager
 
UnmodifiableFilterChain - Class in org.jodconverter.filter
Unmodifiable implementation of FilterChain.
UnmodifiableFilterChain(Filter...) - Constructor for class org.jodconverter.filter.UnmodifiableFilterChain
Creates an unmodifiable FilterChain that will contains the specified filters.

V

validateOfficeHome(File) - Static method in class org.jodconverter.office.LocalOfficeUtils
Validates that the specified File instance is a valid office home directory.
validateOfficeTemplateProfileDirectory(File) - Static method in class org.jodconverter.office.LocalOfficeUtils
Validates that the specified File instance is a valid office template profile directory.
validateOfficeWorkingDirectory(File) - Static method in class org.jodconverter.office.LocalOfficeUtils
Validates that the specified File instance is a valid office working directory.
valueOf(String) - Static method in enum org.jodconverter.office.OfficeConnectionProtocol
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jodconverter.office.OfficeConnectionProtocol
Returns an array containing the constants of this enum type, in the order they are declared.

W

WindowsProcessManager - Class in org.jodconverter.process
ProcessManager implementation for Windows.
WindowsProcessManager() - Constructor for class org.jodconverter.process.WindowsProcessManager
 
A B C D E F G I J K L M N O P R S T U V W 
Skip navigation links