Index (jodconverter-local 4.2.4 API)

A B C D E F G I J K L M N O P Q 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
addFilter(Filter) - Method in interface org.jodconverter.filter.FilterChain: Adds a filter to the chain.
appendProperties(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
attempt() - Method in class org.jodconverter.office.StartProcessRetryable

B

BASE_SERVICE - Static variable in class org.jodconverter.office.utils.Lo
build() - Method in class org.jodconverter.LocalConverter.Builder
build() - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder: Deprecated.

Builds a ProcessPoolOfficeManager with the current configuration.
build() - Method in class org.jodconverter.office.ExternalOfficeManager.Builder
build() - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder: Deprecated.

Builds a new ExternalOfficeManager.
build() - Method in class org.jodconverter.office.LocalOfficeManager.Builder
builder() - Static method in class org.jodconverter.LocalConverter: Creates a new builder instance.
builder() - Static method in class org.jodconverter.office.ExternalOfficeManager: 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

Calc - Class in org.jodconverter.office.utils: A collection of utility functions to make Office Calc documents (Spreadsheet) easier to use.
CALC_SERVICE - Static variable in class org.jodconverter.office.utils.Lo
canFindPid() - Method in class org.jodconverter.process.AbstractProcessManager
canFindPid() - Method in interface org.jodconverter.process.ProcessManager: Indicates whether the pid of the process can be found using a command line.
canFindPid() - Method in class org.jodconverter.process.PureJavaProcessManager
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
compareVersions(String, String, int) - Static method in class org.jodconverter.office.utils.Info: Compares two versions strings (ex.
connectionProtocol(OfficeConnectionProtocol) - Method in class org.jodconverter.office.ExternalOfficeManager.Builder: Specifies the connection protocol.
connectOnStart(boolean) - Method in class org.jodconverter.office.ExternalOfficeManager.Builder: Specifies whether a connection must be attempted on OfficeManager.start()? If false, a connection will only be attempted the first time an OfficeTask is executed.
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.
connectTimeout(long) - Method in class org.jodconverter.office.ExternalOfficeManager.Builder: Specifies the timeout, in milliseconds, after which a connection attempt will fail.
consume(String) - Method in interface org.jodconverter.process.StreamPumper.LineConsumer: Consumes a line read from the input stream.
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: Deprecated.

Converts an input file to an output file.
convert(File, File, DocumentFormat) - Method in class org.jodconverter.OfficeDocumentConverter: Deprecated.

Converts an input file to an output file.
convert(File, File, DocumentFormat, DocumentFormat) - Method in class org.jodconverter.OfficeDocumentConverter: Deprecated.

Converts an input file to an output file.
convert(FilterChain, File, File) - Method in class org.jodconverter.OfficeDocumentConverter: Deprecated.

Converts an input file to an output file.
convert(FilterChain, File, File, DocumentFormat) - Method in class org.jodconverter.OfficeDocumentConverter: Deprecated.

Converts an input file to an output file.
convert(FilterChain, File, File, DocumentFormat, DocumentFormat) - Method in class org.jodconverter.OfficeDocumentConverter: Deprecated.

Converts an input file to an output file.
copy() - Method in class org.jodconverter.filter.DefaultFilterChain
copy() - Method in interface org.jodconverter.filter.FilterChain: Creates and returns a copy of this object.
copy() - Method in class org.jodconverter.filter.UnmodifiableFilterChain
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.
createInstanceMCF(XComponentContext, Class<T>, String) - Static method in class org.jodconverter.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.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.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.
createPoolEntries() - Method in class org.jodconverter.office.LocalOfficeManager

D

DEFAULT_CONNECT_TIMEOUT - Static variable in class org.jodconverter.office.ExternalOfficeManager: The default timeout when connecting to office.
DEFAULT_INITIAL_DELAY - Static variable in class org.jodconverter.office.ExternalOfficeManager: The default initial delay when connecting to office.
DEFAULT_LOAD_PROPERTIES - Static variable in class org.jodconverter.LocalConverter: The properties which are applied by default when loading a document if not manually overridden.
DEFAULT_PIPE_NAME - Static variable in class org.jodconverter.office.ExternalOfficeManager: The default pipe name to connect to office.
DEFAULT_PORT_NUMBER - Static variable in class org.jodconverter.office.ExternalOfficeManager: The default port number to connect to office.
DEFAULT_RETRY_INTERVAL - Static variable in class org.jodconverter.office.ExternalOfficeManager: The default delay between each try to connect.
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.
Use LocalOfficeManager.builder() instead.
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.
DocumentInserterFilter - Class in org.jodconverter.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.filter.text.DocumentInserterFilter: Creates a new filter that will insert the specified document.
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 class org.jodconverter.filter.draw.PageSelectorFilter: Deprecated.
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.PageCounterFilter
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.PagesSelectorFilter
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.RefreshFilter
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.DocumentInserterFilter
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.GraphicInserterFilter
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.LinkedImagesEmbedderFilter
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.PageCounterFilter: Deprecated.
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.PageMarginsFilter
doFilter(OfficeContext, XComponent, FilterChain) - Method in class org.jodconverter.filter.text.PageSelectorFilter: Deprecated.
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
Draw - Class in org.jodconverter.office.utils: A collection of utility functions to make Office Draw documents (Drawing) easier to use.
DRAW_SERVICE - Static variable in class org.jodconverter.office.utils.Lo

E

execute(OfficeTask) - Method in class org.jodconverter.office.ExternalOfficeManager
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(VerboseProcess) - Constructor for class org.jodconverter.office.ExitCodeRetryable: Creates a new instance of the class for the specified process.
ExternalOfficeManager - Class in org.jodconverter.office: OfficeManager implementation that connects to an external Office process.
ExternalOfficeManager.Builder - Class in org.jodconverter.office: A builder for constructing a ExternalOfficeManager.
ExternalOfficeManagerBuilder - Class in org.jodconverter.office: Deprecated.
Use ExternalOfficeManager.builder() instead.
ExternalOfficeManagerBuilder() - Constructor for class org.jodconverter.office.ExternalOfficeManagerBuilder: Deprecated.

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
FreeBSDProcessManager - Class in org.jodconverter.process
FreeBSDProcessManager() - Constructor for class org.jodconverter.process.FreeBSDProcessManager
fromExecutablePath(String) - Static method in class org.jodconverter.office.OfficeDescriptor: Creates descriptor from the office installation path.
fromHelpOutput(List<String>) - Static method in class org.jodconverter.office.OfficeDescriptor: Creates descriptor from the command line output using the help option.

G

getArgument() - Method in class org.jodconverter.process.ProcessQuery: Gets the arguments of the process to query.
getCalcDoc(XComponent) - Static method in class org.jodconverter.office.utils.Calc: Casts the given document into a XSpreadsheetDocument.
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.
getConfig(XComponentContext, String) - Static method in class org.jodconverter.office.utils.Info: Gets the configuration value of the specified property.
getConfig(XComponentContext, String, String) - Static method in class org.jodconverter.office.utils.Info: Gets the configuration value of the specified property for the specified path.
getConfigProperties(XComponentContext, String) - Static method in class org.jodconverter.office.utils.Info: Gets the configuration properties for the specified path.
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.
getConsumer() - Method in class org.jodconverter.process.StreamPumper: Gets the consumer of lines read from the input stream.
getDefault() - Static method in class org.jodconverter.process.FreeBSDProcessManager: Gets the default instance of FreeBSDProcessManager.
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.
getDocumentFamily(XComponent) - Static method in class org.jodconverter.office.LocalOfficeUtils: Gets the DocumentFamily of the specified document.
getErrorPumper() - Method in class org.jodconverter.process.LinesPumpStreamHandler
getErrorPumper() - Method in class org.jodconverter.process.PumpStreamHandler: Gets the error StreamPumper.
getExitCode() - Method in class org.jodconverter.office.ExitCodeRetryable: The exit code of the process.
getFormatRegistry() - Method in class org.jodconverter.OfficeDocumentConverter: Deprecated.

Gets all the DocumentFormat supported by the converter.
getLines() - Method in class org.jodconverter.process.LinesStreamPumper: Gets the lines read from the stream by this pumper.
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.
getOfficeName(XComponentContext) - Static method in class org.jodconverter.office.utils.Info: Gets the office product name for the given context.
getOfficeVersionLong(XComponentContext) - Static method in class org.jodconverter.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.office.utils.Info: Gets the office product version (short representation) for the given context, e.g 6.1
getOutputPumper() - Method in class org.jodconverter.process.LinesPumpStreamHandler
getOutputPumper() - Method in class org.jodconverter.process.PumpStreamHandler: Gets the output StreamPumper.
getPageCount() - Method in class org.jodconverter.filter.PageCounterFilter: Gets the number of pages within the document when the filter has been invoked.
getPageCount() - Method in class org.jodconverter.filter.text.PageCounterFilter: Deprecated.

Gets the number of pages within the document when the filter has been invoked.
getProcess() - Method in class org.jodconverter.office.StartProcessRetryable: Gets the process started by this retryable.
getProcessId() - Method in class org.jodconverter.office.StartProcessRetryable: Gets the process id of the process started by this retryable.
getProduct() - Method in class org.jodconverter.office.OfficeDescriptor: Gets the product name of the office installation being used.
getProperty(Object, String) - Static method in class org.jodconverter.office.utils.Props: Gets a property value from the properties of the specified object.
getProperty(XPropertySet, String) - Static method in class org.jodconverter.office.utils.Props: Gets a property value from the specified properties.
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.FreeBSDProcessManager
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
getServiceFactory(XComponent) - Static method in class org.jodconverter.office.utils.Lo: Gets the XMultiServiceFactory for the given component.
getShapeProperties() - Method in class org.jodconverter.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.office.utils.Write: Casts the given document into a XTextDocument.
getVersion() - Method in class org.jodconverter.office.OfficeDescriptor: Gets the version of the office installation being used.
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

IMPRESS_SERVICE - Static variable in class org.jodconverter.office.utils.Lo
Info - Class in org.jodconverter.office.utils: A collection of utility functions to make Office info easier to get.
install() - Static method in class org.jodconverter.office.ExternalOfficeManager: Creates a new ExternalOfficeManager with default configuration.
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.
Use RefreshFilter.LAST_REFRESH.
isCalc(XComponent) - Static method in class org.jodconverter.office.utils.Calc: Gets whether the given document is a Spreadsheet document.
isDocumentType(XComponent, String) - Static method in class org.jodconverter.office.utils.Info: Gets whether the given document is of the given document type.
isDraw(XComponent) - Static method in class org.jodconverter.office.utils.Draw: Gets whether the given document is a Draw document.
isImpress(XComponent) - Static method in class org.jodconverter.office.utils.Draw: Gets whether the given document is a Presentation document.
isLibreOffice(XComponentContext) - Static method in class org.jodconverter.office.utils.Info: Gets whether the specified context is for a LibreOffice installation.
isOpenOffice(XComponentContext) - Static method in class org.jodconverter.office.utils.Info: Gets whether the specified context is for an OpenOffice installation.
isRunning() - Method in class org.jodconverter.office.ExternalOfficeManager
isText(XComponent) - Static method in class org.jodconverter.office.utils.Write: Gets whether the given document is a Text document.
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.
LinesPumpStreamHandler - Class in org.jodconverter.process: Copies standard output and error of subprocesses to list of lines.
LinesPumpStreamHandler(InputStream, InputStream) - Constructor for class org.jodconverter.process.LinesPumpStreamHandler: Construct a new LinesPumpStreamHandler.
LinesStreamPumper - Class in org.jodconverter.process: Read all lines from an input stream.
LinesStreamPumper(InputStream) - Constructor for class org.jodconverter.process.LinesStreamPumper: Creates a new pumper for the specified stream.
LinkedImagesEmbedderFilter - Class in org.jodconverter.filter.text: This filter is used to insert a graphics into a document.
LinkedImagesEmbedderFilter() - Constructor for class org.jodconverter.filter.text.LinkedImagesEmbedderFilter
Lo - Class in org.jodconverter.office.utils: A collection of utility functions to make Office easier to use.
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: Provides helper functions for local 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 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.ExternalOfficeManager: Creates a new ExternalOfficeManager with default configuration.
make() - Static method in class org.jodconverter.office.LocalOfficeManager: Creates a new LocalOfficeManager with default configuration.
makeProperties(String, Object) - Static method in class org.jodconverter.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.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.office.utils.Props: Creates an array of PropertyValue with properties using the specified property names and values.
MATH_SERVICE - Static variable in class org.jodconverter.office.utils.Lo
MAX_RETRY_INTERVAL - Static variable in class org.jodconverter.office.ExternalOfficeManager: The maximum value for the delay between each try to connect.
maxTasksPerProcess(int) - Method in class org.jodconverter.office.LocalOfficeManager.Builder: Specifies the maximum number of tasks an office process can execute before restarting.
modifyDocument(OfficeContext, XComponent) - Method in class org.jodconverter.task.LocalConversionTask

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.
OfficeDescriptor - Class in org.jodconverter.office: Contains basic information about the office installation being used.
OfficeDocumentConverter - Class in org.jodconverter: Deprecated.
OfficeDocumentConverter(OfficeManager) - Constructor for class org.jodconverter.OfficeDocumentConverter: Deprecated.

Constructs a new instance of the class with the specified manager.
OfficeDocumentConverter(OfficeManager, DocumentFormatRegistry) - Constructor for class org.jodconverter.OfficeDocumentConverter: Deprecated.

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 provides the main converter of the JodConverter local module and a useful static converter for one-liner conversion tasks.
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.draw - package org.jodconverter.filter.draw
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: 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.office.utils - package org.jodconverter.office.utils
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: This package contains the interfaces/classes related to the tasks an office process can execute.

P

PageCounterFilter - Class in org.jodconverter.filter: This filter is used to count the number of pages of a document.
PageCounterFilter() - Constructor for class org.jodconverter.filter.PageCounterFilter
PageCounterFilter - Class in org.jodconverter.filter.text: Deprecated.
Use PageCounterFilter instead.
PageCounterFilter() - Constructor for class org.jodconverter.filter.text.PageCounterFilter: Deprecated.
PageMarginsFilter - Class in org.jodconverter.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.filter.text.PageMarginsFilter: Creates a new filter that will set the margins of the document.
PageSelectorFilter - Class in org.jodconverter.filter.draw: Deprecated.
Use PagesSelectorFilter instead.
PageSelectorFilter(int) - Constructor for class org.jodconverter.filter.draw.PageSelectorFilter: Deprecated.

Creates a new filter that will select the specified page while converting a document (only the given page will be converted).
PageSelectorFilter - Class in org.jodconverter.filter.text: Deprecated.
Use PagesSelectorFilter instead.
PageSelectorFilter(int) - Constructor for class org.jodconverter.filter.text.PageSelectorFilter: Deprecated.

Creates a new filter that will select the specified page while converting a document (only the given page will be converted).
PagesSelectorFilter - Class in org.jodconverter.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.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.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.process.ProcessManager
PID_UNKNOWN - Static variable in interface org.jodconverter.process.ProcessManager
pipeName(String) - Method in class org.jodconverter.office.ExternalOfficeManager.Builder: Specifies the pipe name that will be use to communicate with office.
pipeNames(String...) - Method in class org.jodconverter.office.LocalOfficeManager.Builder: Specifies the pipe names that will be use to communicate with office.
portNumber(int) - Method in class org.jodconverter.office.ExternalOfficeManager.Builder: Specifies the port number 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.
Props - Class in org.jodconverter.office.utils: A collection of utility functions to make Office properties easier to use.
PumpStreamHandler - Class in org.jodconverter.process: Copies standard output and error of subprocesses to given stream pumpers.
PumpStreamHandler(StreamPumper, StreamPumper) - Constructor for class org.jodconverter.process.PumpStreamHandler: Construct a new PumpStreamHandler.
PureJavaProcessManager - Class in org.jodconverter.process
PureJavaProcessManager() - Constructor for class org.jodconverter.process.PureJavaProcessManager

Q

qi(Class<T>, Object) - Static method in class org.jodconverter.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.office.utils.Lo: Queries the given UNO object for the given Java class (which must represent a UNO interface type).

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.
retryInterval(long) - Method in class org.jodconverter.office.ExternalOfficeManager.Builder: Specifies the delay, in milliseconds, between each try when trying to connect to office.
run() - Method in class org.jodconverter.process.StreamPumper
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: Deprecated.

Sets the connection protocol.
setConnectOnStart(boolean) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder: Deprecated.

Sets whether a connection is attempted on start.
setConnectTimeout(long) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder: Deprecated.

Sets the timeout after which a connection attempt will fail.
setDefaultLoadProperties(Map<String, Object>) - Method in class org.jodconverter.OfficeDocumentConverter: Deprecated.

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: Deprecated.

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: Deprecated.

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.
start() - Method in class org.jodconverter.office.ExternalOfficeManager
start() - Method in class org.jodconverter.process.PumpStreamHandler: Start the pumpers.
StartProcessRetryable - Class in org.jodconverter.office: Performs a starts of an office process.
StartProcessRetryable(OfficeProcessConfig, ProcessBuilder, ProcessQuery) - Constructor for class org.jodconverter.office.StartProcessRetryable: Creates a new instance of the class.
stop() - Method in class org.jodconverter.office.ExternalOfficeManager
stop() - Method in class org.jodconverter.process.PumpStreamHandler: Stop pumping the streams.
stopQuietly(OfficeManager) - Static method in class org.jodconverter.office.LocalOfficeUtils: Deprecated.
Use OfficeUtils.stopQuietly(OfficeManager) instead.
storeDocument(XComponent, File) - Method in class org.jodconverter.task.LocalConversionTask
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.
StreamPumper - Class in org.jodconverter.process: Read all lines from an input stream.
StreamPumper(InputStream, StreamPumper.LineConsumer) - Constructor for class org.jodconverter.process.StreamPumper: Creates a new pumper for the specified stream.
StreamPumper.LineConsumer - Interface in org.jodconverter.process: Provides a function to consume a line read from a stream.

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.
templateProfileDirOrDefault(File) - Method in class org.jodconverter.office.LocalOfficeManager.Builder: Specifies the directory to copy to the temporary office profile directories to be created.
templateProfileDirOrDefault(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.
toString() - Method in class org.jodconverter.office.OfficeDescriptor
toString() - Method in class org.jodconverter.process.ProcessQuery
toString() - Method in class org.jodconverter.task.AbstractLocalOfficeTask
toString() - Method in class org.jodconverter.task.LocalConversionTask
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
UNKNOWN_SERVICE - Static variable in class org.jodconverter.office.utils.Lo
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.
useLongOptionNameGnuStyle() - Method in class org.jodconverter.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.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
WrappedUnoException - Exception in org.jodconverter.office.utils: This is an exception that wraps a checked exception thrown by office.
WrappedUnoException(String, Exception) - Constructor for exception org.jodconverter.office.utils.WrappedUnoException: Constructs a new exception with the specified detail message and wrapped exception.
WrappedUnoException(Exception) - Constructor for exception org.jodconverter.office.utils.WrappedUnoException: Constructs a new exception with the specified wrapped exception.
Write - Class in org.jodconverter.office.utils: A collection of utility functions to make Office Text documents (Writer) easier to use.
WRITER_SERVICE - Static variable in class org.jodconverter.office.utils.Lo

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