org.jodconverter.office.utils

Class Info

java.lang.Object

org.jodconverter.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(String version1, String version2, int length) Compares two versions strings (ex.
static Optional<String>	getConfig(XComponentContext context, String propName) Gets the configuration value of the specified property.
static Optional<Object>	getConfig(XComponentContext context, String nodePath, String propName) Gets the configuration value of the specified property for the specified path.
static Optional<com.sun.star.beans.XPropertySet>	getConfigProperties(XComponentContext context, String nodePath) Gets the configuration properties for the specified path.
static String	getOfficeName(XComponentContext context) Gets the office product name for the given context.
static String	getOfficeVersionLong(XComponentContext context) Gets the office product version (long representation) for the given context, e.g 6.1.0.3
static String	getOfficeVersionShort(XComponentContext context) Gets the office product version (short representation) for the given context, e.g 6.1
static boolean	isDocumentType(com.sun.star.lang.XComponent document, String documentType) Gets whether the given document is of the given document type.
static boolean	isLibreOffice(XComponentContext context) Gets whether the specified context is for a LibreOffice installation.
static boolean	isOpenOffice(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

isOpenOffice

public static boolean isOpenOffice(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(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 String getOfficeName(XComponentContext context)

Gets the office product name for the given context.

Parameters:

context - The context.

Returns:

The office product name, or 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 String getOfficeVersionLong(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 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 String getOfficeVersionShort(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 if it could not be retrieved.

Throws:

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

compareVersions

public static int compareVersions(String version1,
                                  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.

getConfig

public static Optional<String> getConfig(XComponentContext context,
                                         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:

An optional containing the property value.

Throws:

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

getConfig

public static Optional<Object> getConfig(XComponentContext context,
                                         String nodePath,
                                         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:

An optional containing the property value.

Throws:

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

getConfigProperties

public static Optional<com.sun.star.beans.XPropertySet> getConfigProperties(XComponentContext context,
                                                                            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:

An optional XPropertySet containing the configuration properties for the specified path.

isDocumentType

public static boolean isDocumentType(com.sun.star.lang.XComponent document,
                                     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.