org.jodconverter.local.office.utils

Class Props

java.lang.Object

org.jodconverter.local.office.utils.Props

public final class Props
extends java.lang.Object

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

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

Method Summary

Modifier and Type	Method and Description
static @NonNull java.lang.Object	getProperty(@NonNull java.lang.Object obj, @NonNull java.lang.String propName) Gets a property value from the properties of the specified object.
static @NonNull java.lang.Object	getProperty(@NonNull com.sun.star.beans.XPropertySet props, @NonNull java.lang.String propName) Gets a property value from the specified properties.
static @NonNull com.sun.star.beans.PropertyValue[]	makeProperties(@NonNull java.lang.String[] names, @NonNull java.lang.Object[] values) Creates an array of PropertyValue with properties using the specified property names and values.
static @NonNull com.sun.star.beans.PropertyValue[]	makeProperties(@NonNull java.lang.String name, @NonNull java.lang.Object value) Creates an array of PropertyValue with a single property using the specified property name and value.
static @NonNull com.sun.star.beans.PropertyValue[]	makeProperties(@NonNull java.lang.String name1, @NonNull java.lang.Object value1, @NonNull java.lang.String name2, @NonNull java.lang.Object value2) Creates an array of PropertyValue with 2 properties using the specified property names and values.
static @NonNull com.sun.star.beans.PropertyValue	makeProperty(@NonNull java.lang.String name, @NonNull java.lang.Object value) Creates a PropertyValue with the specified name and value.

Methods inherited from class java.lang.Object

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

Method Detail

getProperty

public static @NonNull java.lang.Object getProperty(@NonNull java.lang.Object obj,
                                                    @NonNull java.lang.String propName)

Gets a property value from the properties of the specified object.

Parameters:

obj - The object from which a property is get.

propName - The property name to get.

Returns:

The property value, or null if the property could not be retrieved.

Throws:

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

getProperty

public static @NonNull java.lang.Object getProperty(@NonNull com.sun.star.beans.XPropertySet props,
                                                    @NonNull java.lang.String propName)

Gets a property value from the specified properties.

Parameters:

props - The XPropertySet from which a property is get.

propName - The property name to get.

Returns:

The property value, or null if the property could not be retrieved.

Throws:

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

makeProperty

public static @NonNull com.sun.star.beans.PropertyValue makeProperty(@NonNull java.lang.String name,
                                                                     @NonNull java.lang.Object value)

Creates a PropertyValue with the specified name and value.

Parameters:

name - The property name.

value - The property value.

Returns:

The created PropertyValue.

makeProperties

public static @NonNull com.sun.star.beans.PropertyValue[] makeProperties(@NonNull java.lang.String name,
                                                                         @NonNull java.lang.Object value)

Creates an array of PropertyValue with a single property using the specified property name and value.

Parameters:

name - The property name.

value - The property value.

Returns:

An array of size 1.

makeProperties

public static @NonNull com.sun.star.beans.PropertyValue[] makeProperties(@NonNull java.lang.String name1,
                                                                         @NonNull java.lang.Object value1,
                                                                         @NonNull java.lang.String name2,
                                                                         @NonNull java.lang.Object value2)

Creates an array of PropertyValue with 2 properties using the specified property names and values.

Parameters:

name1 - The first property name.

value1 - The first property value.

name2 - The second property name.

value2 - The second property value.

Returns:

An array of size 2.

makeProperties

public static @NonNull com.sun.star.beans.PropertyValue[] makeProperties(@NonNull java.lang.String[] names,
                                                                         @NonNull java.lang.Object[] values)

Creates an array of PropertyValue with properties using the specified property names and values.

Parameters:

names - The property names.

values - The property values.

Returns:

An array of properties.