org.jodconverter.local.office.utils

Class Info

java.lang.Object

org.jodconverter.local.office.utils.Info

public final class Info
extends Object

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

Inspired by the work of Dr. Andrew Davison from the website Java LibreOffice Programming.

Method Summary

Modifier and Type	Method and Description
static int	compareVersions(@Nullable String version1, @Nullable String version2, int length) Compares two versions strings (ex.
static @Nullable String	getConfig(@NonNull com.sun.star.uno.XComponentContext context, @NonNull String propName) Gets the configuration value of the specified property.
static @Nullable Object	getConfig(@NonNull com.sun.star.uno.XComponentContext context, @NonNull String nodePath, @NonNull String propName) Gets the configuration value of the specified property for the specified path.
static @Nullable Object	getConfigAccess(@NonNull com.sun.star.uno.XComponentContext context, @NonNull String nodePath) Gets the read-only configuration access for the specified path.
static @Nullable com.sun.star.beans.XPropertySet	getConfigProperties(@NonNull com.sun.star.uno.XComponentContext context, @NonNull String nodePath) Gets the configuration properties for the specified path.
static @Nullable Object	getConfigUpdateAccess(@NonNull com.sun.star.uno.XComponentContext context, @NonNull String nodePath) Gets the updatable configuration access for the specified path.
static @Nullable String	getOfficeName(@NonNull com.sun.star.uno.XComponentContext context) Gets the office product name for the given context.
static @Nullable String	getOfficeVersionLong(@NonNull com.sun.star.uno.XComponentContext context) Gets the office product version (long representation) for the given context, e.g 6.1.0.3
static @Nullable String	getOfficeVersionShort(@NonNull com.sun.star.uno.XComponentContext context) Gets the office product version (short representation) for the given context, e.g 6.1
static boolean	isDocumentType(@NonNull com.sun.star.lang.XComponent document, @NonNull String documentType) Gets whether the given document is of the given document type.
static boolean	isLibreOffice(@NonNull com.sun.star.uno.XComponentContext context) Gets whether the specified context is for a LibreOffice installation.
static boolean	isOpenOffice(@NonNull com.sun.star.uno.XComponentContext context) Gets whether the specified context is for an OpenOffice installation.

Methods inherited from class java.lang.Object

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

Method Detail

compareVersions

public static int compareVersions(@Nullable String version1,
                                  @Nullable String version2,
                                  int length)

Compares two versions strings (ex. 1.6.1).

Parameters:

version1 - The first version to compare.

version2 - The second version to compare.

length - The version length for normalization.

Returns:

-1 if version1 < version2, 1 if version1 > version2, 0 if version1 = version2.

isDocumentType

public static boolean isDocumentType(@NonNull com.sun.star.lang.XComponent document,
                                     @NonNull String documentType)

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

Parameters:

document - The document.

documentType - The document type to check.

Returns:

true if the document is of the specified type, true otherwise.

isOpenOffice

public static boolean isOpenOffice(@NonNull com.sun.star.uno.XComponentContext context)

Gets whether the specified context is for an OpenOffice installation.

Parameters:

context - The context.

Returns:

true if the specified context is for an OpenOffice installation, false otherwise.

Throws:

WrappedUnoException - If an UNO exception occurs. The UNO exception will be the cause of the WrappedUnoException.

isLibreOffice

public static boolean isLibreOffice(@NonNull com.sun.star.uno.XComponentContext context)

Gets whether the specified context is for a LibreOffice installation.

Parameters:

context - The context.

Returns:

true if the specified context is for an LibreOffice installation, false otherwise.

Throws:

WrappedUnoException - If an UNO exception occurs. The UNO exception will be the cause of the WrappedUnoException.

getOfficeName

public static @Nullable String getOfficeName(@NonNull com.sun.star.uno.XComponentContext context)

Gets the office product name for the given context.

Parameters:

context - The context.

Returns:

The office product name, or null if it could not be retrieved.

Throws:

WrappedUnoException - If an UNO exception occurs. The UNO exception will be the cause of the WrappedUnoException.

getOfficeVersionLong

public static @Nullable String getOfficeVersionLong(@NonNull com.sun.star.uno.XComponentContext context)

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

Parameters:

context - The context.

Returns:

The office product version, or null if it could not be retrieved.

Throws:

WrappedUnoException - If an UNO exception occurs. The UNO exception will be the cause of the WrappedUnoException.

getOfficeVersionShort

public static @Nullable String getOfficeVersionShort(@NonNull com.sun.star.uno.XComponentContext context)

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

Parameters:

context - The context.

Returns:

The office product version, or null if it could not be retrieved.

Throws:

WrappedUnoException - If an UNO exception occurs. The UNO exception will be the cause of the WrappedUnoException.

getConfig

public static @Nullable String getConfig(@NonNull com.sun.star.uno.XComponentContext context,
                                         @NonNull String propName)

Gets the configuration value of the specified property.

Parameters:

context - The main context.

propName - The property name of the property value to get.

Returns:

The property value, or null if not found.

Throws:

WrappedUnoException - If an UNO exception occurs. The UNO exception will be the cause of the WrappedUnoException.

getConfig

public static @Nullable Object getConfig(@NonNull com.sun.star.uno.XComponentContext context,
                                         @NonNull String nodePath,
                                         @NonNull String propName)

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

Parameters:

context - The main context.

nodePath - The path for which the properties are get.

propName - The property name of the property value to get.

Returns:

The property value, or null if not found.

Throws:

WrappedUnoException - If an UNO exception occurs. The UNO exception will be the cause of the WrappedUnoException.

getConfigProperties

public static @Nullable com.sun.star.beans.XPropertySet getConfigProperties(@NonNull com.sun.star.uno.XComponentContext context,
                                                                            @NonNull String nodePath)

Gets the configuration properties for the specified path.

Parameters:

context - The main context.

nodePath - The path for which the properties are get.

Returns:

A XPropertySet containing the configuration properties for the specified path, or null if not found.

getConfigAccess

public static @Nullable Object getConfigAccess(@NonNull com.sun.star.uno.XComponentContext context,
                                               @NonNull String nodePath)

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

Parameters:

context - The main context.

nodePath - The path for which the configuration access is get.

Returns:

The read-only configuration access service, or null if not available.

getConfigUpdateAccess

public static @Nullable Object getConfigUpdateAccess(@NonNull com.sun.star.uno.XComponentContext context,
                                                     @NonNull String nodePath)

Gets the updatable configuration access for the specified path.

Parameters:

context - The main context.

nodePath - The path for which the configuration access is get.

Returns:

The updatable configuration access service, or null if not available.