Module org.freedesktop.dbus

Package org.freedesktop.dbus

Class Marshalling

java.lang.Object

org.freedesktop.dbus.Marshalling

public final class Marshalling
extends Object

Contains static methods for marshalling values.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<Class<?>,Byte>	CLASS_TO_ARGUMENTTYPE
private static final String[]	EMPTY_STRING_ARRAY
private static final Type[]	EMPTY_TYPE_ARRAY
private static final String	ERROR_MULTI_VALUED_ARRAY
private static final int	INITIAL_BUFFER_SZ	Used as initial and incremental size of StringBuffer array when resolving DBusTypes recursively.
private static final org.slf4j.Logger	LOGGER
private static final String	MTH_NAME_DESERIALIZE
private static final Map<Type,String[]>	TYPE_CACHE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Marshalling()

Method Summary

Modifier and Type	Method	Description
static String	convertJavaClassesToSignature(Class<?>... _javaType)	Will return the DBus type corresponding to the given Java type.
static Object[]	convertParameters(Object[] _parameters, Type[] _types, String[] _customSignatures, AbstractConnectionBase _conn)	Recursively converts types for serialization onto DBus. When _customSignature is not empty or null, it will be used to wrap the given parameters to a Variant of the type defined in the _customSignature array. It is required that every Variant passed has a signature definition in _customSignature. E.g.
static Object[]	convertParameters(Object[] _parameters, Type[] _types, AbstractConnectionBase _conn)	Recursively converts types for serialization onto DBus.
private static int	convertToSig(StringBuilder _sig, int _idx, Class<?>... _javaType)
(package private) static Object	deSerializeParameter(Object _parameter, Type _type, AbstractConnectionBase _conn)
static Object[]	deSerializeParameters(Object[] _parameters, Type[] _types, AbstractConnectionBase _conn)
(package private) static List<Object>	deSerializeParameters(List<Object> _parameters, Type _type, AbstractConnectionBase _conn)
static String[]	getDBusType(Type _javaType)	Will return the DBus type corresponding to the given Java type.
static String	getDBusType(Type[] _javaType)	Will return the DBus type corresponding to the given Java type.
static String[]	getDBusType(Type _dataType, boolean _basic)	Will return the DBus type corresponding to the given Java type.
static int	getJavaType(String _dbusType, List<Type> _resultValue, int _limit)	Converts a dbus type string into Java Type objects,
private static String[]	recursiveGetDBusType(StringBuffer[] _out, Type _dataType, boolean _basic, int _level)

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_STRING_ARRAY

private static final String[] EMPTY_STRING_ARRAY

EMPTY_TYPE_ARRAY

private static final Type[] EMPTY_TYPE_ARRAY

INITIAL_BUFFER_SZ

private static final int INITIAL_BUFFER_SZ

Used as initial and incremental size of StringBuffer array when resolving DBusTypes recursively.

See Also:

• Constant Field Values

MTH_NAME_DESERIALIZE

private static final String MTH_NAME_DESERIALIZE

See Also:

• Constant Field Values

ERROR_MULTI_VALUED_ARRAY

private static final String ERROR_MULTI_VALUED_ARRAY

See Also:

• Constant Field Values

LOGGER

private static final org.slf4j.Logger LOGGER

TYPE_CACHE

private static final Map<Type,String[]> TYPE_CACHE

CLASS_TO_ARGUMENTTYPE

private static final Map<Class<?>,Byte> CLASS_TO_ARGUMENTTYPE

Constructor Details

Marshalling

private Marshalling()

Method Details

getDBusType

public static String getDBusType(Type[] _javaType)
                          throws DBusException

Will return the DBus type corresponding to the given Java type. Note, container type should have their ParameterizedType not their Class passed in here.

Parameters:

_javaType - The Java types.

Returns:

The DBus types.

Throws:

DBusException

convertJavaClassesToSignature

public static String convertJavaClassesToSignature(Class<?>... _javaType)
                                            throws DBusTypeConversationRuntimeException

Will return the DBus type corresponding to the given Java type. Note, container type should have their ParameterizedType not their Class passed in here.

Parameters:

_javaType - The Java types.

Returns:

The DBus types

Throws:

DBusTypeConversationRuntimeException - when conversation fails

Since:

5.1.0 - 2024-05-19

convertToSig

private static int convertToSig(StringBuilder _sig,
 int _idx,
 Class<?>... _javaType)

getDBusType

public static String[] getDBusType(Type _javaType)
                            throws DBusException

Will return the DBus type corresponding to the given Java type. Note, container type should have their ParameterizedType not their Class passed in here.

Parameters:

_javaType - The Java type.

Returns:

The DBus type.

Throws:

DBusException - If the given type cannot be converted to a DBus type.

getDBusType

public static String[] getDBusType(Type _dataType,
 boolean _basic)
                            throws DBusException

Will return the DBus type corresponding to the given Java type. Note, container type should have their ParameterizedType not their Class passed in here.

Parameters:

_dataType - The Java type.

_basic - If true enforces this to be a non-compound type. (compound types are Maps, Structs and Lists/arrays).

Returns:

The DBus type.

Throws:

DBusException - If the given type cannot be converted to a DBus type.

recursiveGetDBusType

private static String[] recursiveGetDBusType(StringBuffer[] _out,
 Type _dataType,
 boolean _basic,
 int _level)
                                      throws DBusException

Throws:

DBusException

getJavaType

public static int getJavaType(String _dbusType,
 List<Type> _resultValue,
 int _limit)
                       throws DBusException

Converts a dbus type string into Java Type objects,

Parameters:

_dbusType - The DBus type or types.

_resultValue - List to return the types in.

_limit - Maximum number of types to parse (-1 == nolimit).

Returns:

number of characters parsed from the type string.

Throws:

DBusException - on error

convertParameters

public static Object[] convertParameters(Object[] _parameters,
 Type[] _types,
 String[] _customSignatures,
 AbstractConnectionBase _conn)
                                  throws DBusException

Recursively converts types for serialization onto DBus.

When _customSignature is not empty or null, it will be used to wrap the given parameters to a Variant
of the type defined in the _customSignature array.
It is required that every Variant passed has a signature definition in _customSignature.
E.g. 3 Objects are given in _parameters: String, Variant, Variant.
Then it is expected that _customSignature (if used) contains 2 entries one for each Variant.

If the _customSignature is smaller than the count of Variants in _parameters, all remaining Variants
are created without a explicit signature (Variant constructor will try to determine type automatically).
If more entries are given then Variants found in _parameters, the additional signatures are ignored.

Parameters:

_parameters - The parameters to convert.

_types - The (possibly generic) types of the parameters.

_customSignatures - custom signatures used for variants found in _types, each found variant must have one matching custom signature

_conn - the connection

Returns:

The converted parameters.

Throws:

DBusException - Thrown if there is an error in converting the objects.

convertParameters

public static Object[] convertParameters(Object[] _parameters,
 Type[] _types,
 AbstractConnectionBase _conn)
                                  throws DBusException

Recursively converts types for serialization onto DBus.

Parameters:

_parameters - The parameters to convert.

_types - The (possibly generic) types of the parameters.

_conn - the connection

Returns:

The converted parameters.

Throws:

DBusException - Thrown if there is an error in converting the objects.

deSerializeParameter

static Object deSerializeParameter(Object _parameter,
 Type _type,
 AbstractConnectionBase _conn)
                            throws Exception

Throws:

Exception

deSerializeParameters

static List<Object> deSerializeParameters(List<Object> _parameters,
 Type _type,
 AbstractConnectionBase _conn)
                                   throws Exception

Throws:

Exception

deSerializeParameters

public static Object[] deSerializeParameters(Object[] _parameters,
 Type[] _types,
 AbstractConnectionBase _conn)
                                      throws Exception

Throws:

Exception