org.jodconverter.office.utils

Class Props

java.lang.Object

org.jodconverter.office.utils.Props

public final class Props
extends 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 Optional<Object>	getProperty(Object obj, String propName) Gets a property value from the properties of the specified object.
static Optional<Object>	getProperty(com.sun.star.beans.XPropertySet props, String propName) Gets a property value from the specified properties.
static com.sun.star.beans.PropertyValue[]	makeProperties(String[] names, Object[] values) Creates an array of PropertyValue with properties using the specified property names and values.
static com.sun.star.beans.PropertyValue[]	makeProperties(String name, Object value) Creates an array of PropertyValue with a single property using the specified property name and value.
static com.sun.star.beans.PropertyValue[]	makeProperties(String name1, Object value1, String name2, Object value2) Creates an array of PropertyValue with 2 properties using the specified property names and values.

Methods inherited from class java.lang.Object

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

Method Detail

getProperty

public static Optional<Object> getProperty(Object obj,
                                           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:

An optional containing the property value. the optional will be empty 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 Optional<Object> getProperty(com.sun.star.beans.XPropertySet props,
                                           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:

An optional containing the property value. the optional will be empty if the property could not be retrieved.

Throws:

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

makeProperties

public static com.sun.star.beans.PropertyValue[] makeProperties(String name,
                                                                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 com.sun.star.beans.PropertyValue[] makeProperties(String name1,
                                                                Object value1,
                                                                String name2,
                                                                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 com.sun.star.beans.PropertyValue[] makeProperties(String[] names,
                                                                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.