dbus-java 5.1.1 · org.freedesktop.dbus.Marshalling · APIdia, the JavaDoc alternative

Modifier and Type	Field and 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 Logger	LOGGER
private static final String	MTH_NAME_DESERIALIZE
private static final Map<Type, String[]>	TYPE_CACHE

Access	Constructor and Description
private	Marshalling()

Method Summary

Modifier and Type	Method and Description
public static String	Returns: The DBus types convertJavaClassesToSignature(Class<?>... The Java types. _javaType) Will return the DBus type corresponding to the given Java type.
public static Object[]	Returns: The converted parameters. convertParameters(Object[] The parameters to convert. _parameters, Type[] The (possibly generic) types of the parameters. _types, String[] custom signatures used for variants found in _types, each found variant must have one matching custom signature _customSignatures, AbstractConnectionBase the connection _conn) Recursively converts types for serialization onto DBus.
public static Object[]	Returns: The converted parameters. convertParameters(Object[] The parameters to convert. _parameters, Type[] The (possibly generic) types of the parameters. _types, AbstractConnectionBase the connection _conn) Recursively converts types for serialization onto DBus.
private static int	convertToSig(StringBuilder _sig, int _idx, Class<?>... _javaType)
pack-priv static Object	deSerializeParameter(Object _parameter, Type _type, AbstractConnectionBase _conn)
pack-priv static List<Object>	deSerializeParameters(List<Object> _parameters, Type _type, AbstractConnectionBase _conn)
public static Object[]	deSerializeParameters(Object[] _parameters, Type[] _types, AbstractConnectionBase _conn)
public static String	Returns: The DBus types. getDBusType(Type[] The Java types. _javaType) Will return the DBus type corresponding to the given Java type.
public static String[]	Returns: The DBus type. getDBusType(Type The Java type. _javaType) Will return the DBus type corresponding to the given Java type.
public static String[]	Returns: The DBus type. getDBusType(Type The Java type. _dataType, boolean If true enforces this to be a non-compound type. (compound types are Maps, Structs and Lists/arrays). _basic) Will return the DBus type corresponding to the given Java type.
public static int	Returns: number of characters parsed from the type string. getJavaType(String The DBus type or types. _dbusType, List<Type> List to return the types in. _resultValue, int Maximum number of types to parse (-1 == nolimit). _limit) Converts a dbus type string into Java Type objects,
private static String[]	recursiveGetDBusType(StringBuffer[] _out, Type _dataType, boolean _basic, int _level)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CLASS_TO_ARGUMENTTYPE	back to summary
private static final Map<Class<?>, Byte> CLASS_TO_ARGUMENTTYPE

EMPTY_STRING_ARRAY	back to summary
private static final String[] EMPTY_STRING_ARRAY

EMPTY_TYPE_ARRAY	back to summary
private static final Type[] EMPTY_TYPE_ARRAY

ERROR_MULTI_VALUED_ARRAY	back to summary
private static final String ERROR_MULTI_VALUED_ARRAY

INITIAL_BUFFER_SZ	back to summary
private static final int INITIAL_BUFFER_SZ Used as initial and incremental size of StringBuffer array when resolving DBusTypes recursively.

LOGGER	back to summary
private static final Logger LOGGER

MTH_NAME_DESERIALIZE	back to summary
private static final String MTH_NAME_DESERIALIZE

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

Marshalling	back to summary
private Marshalling()

Method Detail

convertJavaClassesToSignature	back to summary
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:Class<?>[] The Java types. Returns:String The DBus types Exceptions DBusTypeConversationRuntimeException: when conversation fails Since 5.1.0 - 2024-05-19

convertJavaClassesToSignature

back to summary

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:Class<?>[]: The Java types.

Returns:String

The DBus types

Exceptions

DBusTypeConversationRuntimeException:: when conversation fails

Since

5.1.0 - 2024-05-19

convertParameters back to summary

convertParameters	back to summary
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 `Variant`s in _parameters, all remaining `Variant`s are created without a explicit signature (Variant constructor will try to determine type automatically). If more entries are given then `Variant`s found in _parameters, the additional signatures are ignored. Parameters _parameters:Object[] The parameters to convert. _types:Type[] The (possibly generic) types of the parameters. _customSignatures:String[] custom signatures used for variants found in _types, each found variant must have one matching custom signature _conn:AbstractConnectionBase the connection Returns:Object[] The converted parameters. Exceptions DBusException: Thrown if there is an error in converting the objects.

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:Object[]: The parameters to convert.
_types:Type[]: The (possibly generic) types of the parameters.
_customSignatures:String[]: custom signatures used for variants found in _types, each found variant must have one matching custom signature
_conn:AbstractConnectionBase: the connection

Returns:Object[]

The converted parameters.

Exceptions

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

convertParameters	back to summary
public static Object[] convertParameters(Object[] _parameters, Type[] _types, AbstractConnectionBase _conn) throws DBusException Recursively converts types for serialization onto DBus. Parameters _parameters:Object[] The parameters to convert. _types:Type[] The (possibly generic) types of the parameters. _conn:AbstractConnectionBase the connection Returns:Object[] The converted parameters. Exceptions DBusException: Thrown if there is an error in converting the objects.

convertParameters

back to summary

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

Recursively converts types for serialization onto DBus.

Parameters

_parameters:Object[]: The parameters to convert.
_types:Type[]: The (possibly generic) types of the parameters.
_conn:AbstractConnectionBase: the connection

Returns:Object[]

The converted parameters.

Exceptions

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

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

deSerializeParameter	back to summary
pack-priv static Object deSerializeParameter(Object _parameter, Type _type, AbstractConnectionBase _conn) throws Exception Annotations @SuppressWarnings:unchecked, rawtypes

deSerializeParameters	back to summary
pack-priv static List<Object> deSerializeParameters(List<Object> _parameters, Type _type, AbstractConnectionBase _conn) throws Exception

deSerializeParameters	back to summary
public static Object[] deSerializeParameters(Object[] _parameters, Type[] _types, AbstractConnectionBase _conn) throws Exception Annotations @SuppressWarnings:unchecked

getDBusType	back to summary
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:Type[] The Java types. Returns:String The DBus types.

getDBusType

back to summary

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:Type[]: The Java types.

Returns:String

The DBus types.

getDBusType	back to summary
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:Type The Java type. Returns:String[] The DBus type. Exceptions DBusException: If the given type cannot be converted to a DBus type.

getDBusType

back to summary

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:Type: The Java type.

Returns:String[]

The DBus type.

Exceptions

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

getDBusType	back to summary
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:Type The Java type. _basic:boolean If true enforces this to be a non-compound type. (compound types are Maps, Structs and Lists/arrays). Returns:String[] The DBus type. Exceptions DBusException: If the given type cannot be converted to a DBus type.

getDBusType

back to summary

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:Type: The Java type.
_basic:boolean: If true enforces this to be a non-compound type. (compound types are Maps, Structs and Lists/arrays).

Returns:String[]

The DBus type.

Exceptions

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

getJavaType	back to summary
public static int getJavaType(String _dbusType, List<Type> _resultValue, int _limit) throws DBusException Converts a dbus type string into Java Type objects, Parameters _dbusType:String The DBus type or types. _resultValue:List<Type> List to return the types in. _limit:int Maximum number of types to parse (-1 == nolimit). Returns:int number of characters parsed from the type string. Exceptions DBusException: on error

getJavaType

back to summary

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

Converts a dbus type string into Java Type objects,

Parameters

_dbusType:String: The DBus type or types.
_resultValue:List<Type>: List to return the types in.
_limit:int: Maximum number of types to parse (-1 == nolimit).

Returns:int

number of characters parsed from the type string.

Exceptions

DBusException:: on error

recursiveGetDBusType	back to summary
private static String[] recursiveGetDBusType(StringBuffer[] _out, Type _dataType, boolean _basic, int _level) throws DBusException Annotations @SuppressWarnings:checkstyle:parameterassignment

public final Class Marshalling

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail