org.freedesktop.dbus.interfaces.DBusSerializable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbus-java Show documentation

Improved version of the DBus-Java library provided by freedesktop.org (https://dbus.freedesktop.org/doc/dbus-java/).

There is a newer version: 3.3.2

/*
   D-Bus Java Implementation
   Copyright (c) 2005-2006 Matthew Johnson

   This program is free software; you can redistribute it and/or modify it
   under the terms of either the GNU Lesser General Public License Version 2 or the
   Academic Free Licence Version 2.1.

   Full licence texts are included in the COPYING file with this program.
*/
package org.freedesktop.dbus.interfaces;

import org.freedesktop.dbus.exceptions.DBusException;

/**
 * Custom classes may be sent over DBus if they implement this interface.
 * 
 * In addition to the serialize method, classes MUST implement
 * a deserialize method which returns null and takes as it's arguments
 * all the DBus types the class will be serialied to in order and
 * with type parameterisation. They MUST also provide a
 * zero-argument constructor.
 * 
 * 
 * The serialize method should return the class properties you wish to
 * serialize, correctly formatted for the wire
 * (DBusConnection.convertParameters() can help with this), in order in an
 * Object array.
 * 
 * 
 * The deserialize method will be called once after the zero-argument
 * constructor. This should contain all the code to initialise the object
 * from the types.
 * 
 */
public interface DBusSerializable {
    Object[] serialize() throws DBusException;
}