org.jodconverter.local.office

Class LocalOfficeUtils

java.lang.Object

org.jodconverter.local.office.LocalOfficeUtils

public final class LocalOfficeUtils
extends Object

Provides helper functions for local office.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT

Method Summary

Modifier and Type	Method and Description
static @NonNull List<org.jodconverter.local.office.OfficeUrl>	buildOfficeUrls(@Nullable List<Integer> portNumbers, @Nullable List<String> pipeNames) Builds an array of OfficeUrl from an array of port numbers and an array of pipe names.
static @NonNull List<org.jodconverter.local.office.OfficeUrl>	buildOfficeUrls(@Nullable String host, @Nullable List<Integer> portNumbers, @Nullable List<String> pipeNames) Builds an array of OfficeUrl from an array of port numbers and an array of pipe names.
static @NonNull ProcessManager	findBestProcessManager() Find the best process manager that will be used to retrieve a process PID and to kill a process by PID.
static @NonNull File	getDefaultOfficeHome() Gets the default office home directory, which is auto-detected.
static @NonNull org.jodconverter.core.document.DocumentFamily	getDocumentFamily(@NonNull com.sun.star.lang.XComponent document) Gets the DocumentFamily of the specified document.
static @Nullable org.jodconverter.core.document.DocumentFamily	getDocumentFamilySilently(@NonNull com.sun.star.lang.XComponent document) Gets the DocumentFamily of the specified document, without throwing an exception if not found.
static @NonNull File	getOfficeExecutable(@NonNull File officeHome) Gets the office executable within an office installation.
static @NonNull com.sun.star.beans.PropertyValue[]	toUnoProperties(@NonNull Map<String,Object> properties) Converts a regular java map to an array of PropertyValue, usable as arguments with UNO interface types.
static @NonNull String	toUrl(@NonNull File file) Constructs a URL from the specified file as expected by office.
static void	validateOfficeHome(@NonNull File officeHome) Validates that the specified File instance is a valid office home directory.
static void	validateOfficeTemplateProfileDirectory(@Nullable File templateProfileDir) Validates that the specified File instance is a valid office template profile directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

Method Detail

findBestProcessManager

public static @NonNull ProcessManager findBestProcessManager()

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

Returns:

The best process manager according to the current OS.

buildOfficeUrls

public static @NonNull List<org.jodconverter.local.office.OfficeUrl> buildOfficeUrls(@Nullable List<Integer> portNumbers,
                                                                                     @Nullable List<String> pipeNames)

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

Parameters:

portNumbers - The port numbers from which office URLs will be created, may be null.

pipeNames - The pipe names from which office URLs will be created, may be null.

Returns:

an array of office URL. If both arguments are null, then an array is returned with a single office URL, using the default port number 2002.

buildOfficeUrls

public static @NonNull List<org.jodconverter.local.office.OfficeUrl> buildOfficeUrls(@Nullable String host,
                                                                                     @Nullable List<Integer> portNumbers,
                                                                                     @Nullable List<String> pipeNames)

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

Parameters:

host - The host to which open ports belong, may be null.

portNumbers - The port numbers from which office URLs will be created, may be null.

pipeNames - The pipe names from which office URLs will be created, may be null.

Returns:

an array of office URL. If both arguments are null, then an array is returned with a single office URL, using the default port number 2002.

getDefaultOfficeHome

public static @NonNull File getDefaultOfficeHome()

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

Returns:

A File instance that is the directory where lives the first detected office installation.

getDocumentFamilySilently

public static @Nullable org.jodconverter.core.document.DocumentFamily getDocumentFamilySilently(@NonNull com.sun.star.lang.XComponent document)

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

Parameters:

document - The document whose family will be returned. Must not be null.

Returns:

The DocumentFamily for the specified document, or null if the document does not represent any supported document family.

getDocumentFamily

public static @NonNull org.jodconverter.core.document.DocumentFamily getDocumentFamily(@NonNull com.sun.star.lang.XComponent document)
                                                                                throws org.jodconverter.core.office.OfficeException

Gets the DocumentFamily of the specified document.

Parameters:

document - The document whose family will be returned. Must not be null.

Returns:

The DocumentFamily for the specified document.

Throws:

org.jodconverter.core.office.OfficeException - If the document family cannot be retrieved.

getOfficeExecutable

public static @NonNull File getOfficeExecutable(@NonNull File officeHome)

Gets the office executable within an office installation.

Parameters:

officeHome - The root (home) directory of the office installation.

Returns:

Aninstance of the executable file.

toUnoProperties

public static @NonNull com.sun.star.beans.PropertyValue[] toUnoProperties(@NonNull Map<String,Object> properties)

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

Parameters:

properties - The map to convert.

Returns:

An array of PropertyValue.

toUrl

public static @NonNull String toUrl(@NonNull File file)

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

Parameters:

file - The file for which a URL will be constructed.

Returns:

A valid office URL.

validateOfficeHome

public static void validateOfficeHome(@NonNull File officeHome)

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

Parameters:

officeHome - The home to validate.

Throws:

IllegalStateException - If the specified directory if not a valid office home directory.

validateOfficeTemplateProfileDirectory

public static void validateOfficeTemplateProfileDirectory(@Nullable File templateProfileDir)

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

Parameters:

templateProfileDir - The directory to validate.

Throws:

IllegalStateException - If the specified directory if not a valid office template profile directory.