org.jodconverter.local.office.utils

Class Lo

java.lang.Object

org.jodconverter.local.office.utils.Lo

public final class Lo
extends Object

A collection of utility functions to make Office easier to use.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALC_SERVICE
static String	DRAW_SERVICE
static String	IMPRESS_SERVICE
static String	WEB_SERVICE
static String	WRITER_SERVICE

Method Summary

Modifier and Type	Method and Description
static <T> T	createInstance(@NonNull com.sun.star.lang.XComponent component, @NonNull Class<T> type, @NonNull String serviceName) 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.
static <T> T	createInstance(@NonNull com.sun.star.uno.XComponentContext context, @NonNull Class<T> type, @NonNull String serviceName) 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.
static <T> T	createInstance(@NonNull com.sun.star.lang.XMultiServiceFactory factory, @NonNull Class<T> type, @NonNull String serviceName) 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.
static <T> T	createInstanceMCF(@NonNull com.sun.star.uno.XComponentContext context, @NonNull Class<T> type, @NonNull String serviceName) Deprecated. Use createInstance(XComponentContext, Class, String) instead.
static <T> T	createInstanceMSF(@NonNull com.sun.star.lang.XComponent component, @NonNull Class<T> type, @NonNull String serviceName) Deprecated. Use createInstance(XComponent, Class, String) instead.
static <T> T	createInstanceMSF(@NonNull com.sun.star.lang.XMultiServiceFactory factory, @NonNull Class<T> type, @NonNull String serviceName) Deprecated. Use createInstance(XMultiServiceFactory, Class, String) instead.
static @NonNull com.sun.star.lang.XMultiServiceFactory	getServiceFactory(@NonNull com.sun.star.lang.XComponent component) Gets the XMultiServiceFactory for the given component.
static <T> T	qi(@NonNull Class<T> type, @NonNull Object object) Queries the given UNO object for the given Java class (which must represent a UNO interface type).
static <T> @NonNull Optional<T>	qiOptional(@NonNull Class<T> type, @NonNull Object object) Queries the given UNO object for the given Java class (which must represent a UNO interface type).

Methods inherited from class java.lang.Object

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

Field Detail

WRITER_SERVICE

public static final String WRITER_SERVICE

See Also:

Constant Field Values

WEB_SERVICE

public static final String WEB_SERVICE

See Also:

Constant Field Values

CALC_SERVICE

public static final String CALC_SERVICE

See Also:

Constant Field Values

DRAW_SERVICE

public static final String DRAW_SERVICE

See Also:

Constant Field Values

IMPRESS_SERVICE

public static final String IMPRESS_SERVICE

See Also:

Constant Field Values

Method Detail

qi

public static <T> T qi(@NonNull Class<T> type,
                       @NonNull Object object)

Queries the given UNO object for the given Java class (which must represent a UNO interface type).

Type Parameters:

T - The requested UNO interface type.

Parameters:

type - A Java class representing a UNO interface type; cannot be null.

object - A reference to any Java object representing (a facet of) a UNO object; cannot be null.

Returns:

A reference to the requested UNO interface type.

See Also:

UnoRuntime.queryInterface(Class, Object)

qiOptional

public static <T> @NonNull Optional<T> qiOptional(@NonNull Class<T> type,
                                                  @NonNull Object object)

Queries the given UNO object for the given Java class (which must represent a UNO interface type).

Type Parameters:

T - the requested UNO interface type.

Parameters:

type - A Java class representing a UNO interface type; may be null.

object - A reference to any Java object representing (a facet of) a UNO object; may be null.

Returns:

A reference to the requested UNO interface type if available, otherwise null.

See Also:

UnoRuntime.queryInterface(Class, Object)

getServiceFactory

public static @NonNull com.sun.star.lang.XMultiServiceFactory getServiceFactory(@NonNull com.sun.star.lang.XComponent component)

Gets the XMultiServiceFactory for the given component.

Parameters:

component - The component.

Returns:

The service factory.

createInstance

public static <T> T createInstance(@NonNull com.sun.star.lang.XComponent component,
                                   @NonNull Class<T> type,
                                   @NonNull String serviceName)

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.

Type Parameters:

T - The requested UNO interface type.

Parameters:

component - The component.

type - A Java class representing a UNO interface type.

serviceName - The service name.

Returns:

A reference to the requested UNO interface type if available, otherwise null.

Throws:

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

createInstance

public static <T> T createInstance(@NonNull com.sun.star.lang.XMultiServiceFactory factory,
                                   @NonNull Class<T> type,
                                   @NonNull String serviceName)

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.

Type Parameters:

T - The requested UNO interface type.

Parameters:

factory - The service factory.

type - A Java class representing a UNO interface type.

serviceName - The service name.

Returns:

A reference to the requested UNO interface type if available, otherwise null.

Throws:

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

createInstance

public static <T> T createInstance(@NonNull com.sun.star.uno.XComponentContext context,
                                   @NonNull Class<T> type,
                                   @NonNull String serviceName)

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.

Type Parameters:

T - The requested UNO interface type.

Parameters:

context - The component context.

type - A Java class representing a UNO interface type.

serviceName - The service name.

Returns:

A reference to the requested UNO interface type if available, otherwise null.

Throws:

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

createInstanceMSF

public static <T> T createInstanceMSF(@NonNull com.sun.star.lang.XComponent component,
                                      @NonNull Class<T> type,
                                      @NonNull String serviceName)

Deprecated. Use createInstance(XComponent, Class, String) instead.

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.

Type Parameters:

T - The requested UNO interface type.

Parameters:

component - The component.

type - A Java class representing a UNO interface type.

serviceName - The service name.

Returns:

A reference to the requested UNO interface type if available, otherwise null.

Throws:

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

createInstanceMSF

public static <T> T createInstanceMSF(@NonNull com.sun.star.lang.XMultiServiceFactory factory,
                                      @NonNull Class<T> type,
                                      @NonNull String serviceName)

Deprecated. Use createInstance(XMultiServiceFactory, Class, String) instead.

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.

Type Parameters:

T - The requested UNO interface type.

Parameters:

factory - The service factory.

type - A Java class representing a UNO interface type.

serviceName - The service name.

Returns:

A reference to the requested UNO interface type if available, otherwise null.

Throws:

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

createInstanceMCF

@Deprecated
public static <T> T createInstanceMCF(@NonNull com.sun.star.uno.XComponentContext context,
                                                   @NonNull Class<T> type,
                                                   @NonNull String serviceName)

Deprecated. Use createInstance(XComponentContext, Class, String) instead.

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.

Type Parameters:

T - The requested UNO interface type.

Parameters:

context - The component context.

type - A Java class representing a UNO interface type.

serviceName - The service name.

Returns:

A reference to the requested UNO interface type if available, otherwise null.

Throws:

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