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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbus-java-core 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: 5.1.0
package org.freedesktop.dbus.interfaces;

import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.annotations.DBusInterfaceName;
import org.freedesktop.dbus.exceptions.DBusException;
import org.freedesktop.dbus.messages.DBusSignal;
import org.freedesktop.dbus.types.Variant;

import java.util.List;
import java.util.Map;

@DBusInterfaceName("org.freedesktop.DBus.ObjectManager")
@SuppressWarnings({"checkstyle:methodname", "checkstyle:visibilitymodifier"})
public interface ObjectManager extends DBusInterface {
    /**
     * Get a sub-tree of objects. The root of the sub-tree is this object.
     *
     * @return A Map from object path (DBusInterface) to a Map from interface name to a properties Map (as returned by
     *         Properties.GetAll())
     */
    Map>>> GetManagedObjects();

    /**
     * Signal generated when a new interface is added
     */
    class InterfacesAdded extends DBusSignal {
        public final DBusPath                             signalSource;
        public final String                               objectPath;

        public final Map>> interfaces;

        public InterfacesAdded(String _objectPath, DBusPath _source, Map>> _interfaces)
                throws DBusException {
            super(_objectPath, _source, _interfaces);
            objectPath = _objectPath;
            signalSource = _source;
            interfaces = _interfaces;
        }

        /**
         * The source DBus object path (e.g. /org/bluez/hci0/dev_00_11_22_33_44_55).
         *
         * @return DBusPath
         */
        public DBusPath getSignalSource() {
            return signalSource;

        }

        public String getObjectPath() {
            return objectPath;
        }

        /**
         * Returns the added interfaces. Key is a DBus interface name (like org.bluez.Device1). Value is a Map with
         * properties known for the new device.
         *
         * @return Map
         */
        public Map>> getInterfaces() {
            return interfaces;
        }

        @Override
        public String toString() {
            return getClass().getSimpleName() + "["
                    + "signalSource=" + signalSource
                    + ", objectPath='" + objectPath + '\''
                    + ", interfaces=" + interfaces
                    + ']';
        }
    }

    /**
     * Signal generated when an interface is removed
     */
    class InterfacesRemoved extends DBusSignal {
        public final DBusPath     signalSource;
        public final String       objectPath;

        public final List interfaces;

        public InterfacesRemoved(String _objectPath, DBusPath _source, List _interfaces)
                throws DBusException {
            super(_objectPath, _source, _interfaces);
            objectPath = _objectPath;
            signalSource = _source;
            interfaces = _interfaces;
        }

        /**
         * The source DBus object path (e.g. /org/bluez/hci0/dev_00_11_22_33_44_55).
         *
         * @return DBusPath
         */
        public DBusPath getSignalSource() {
            return signalSource;
        }

        public String getObjectPath() {
            return objectPath;
        }

        /**
         * Returns list of removed DBus interfaces (like org.bluez.Device1).
         *
         * @return List
         */
        public List getInterfaces() {
            return interfaces;
        }

        @Override
        public String toString() {
            return getClass().getSimpleName() + "["
                    + "signalSource=" + signalSource
                    + ", objectPath='" + objectPath + '\''
                    + ", interfaces=" + interfaces
                    + ']';
        }
    }

}