Top Description Inners Methods
org.freedesktop.dbus.interfaces

public Interface Properties

extends DBusInterface
Annotations
@DBusInterfaceName:org.freedesktop.DBus.Properties
@SuppressWarnings:checkstyle:methodname
Imports
org.freedesktop.dbus.annotations.DBusInterfaceName, org.freedesktop.dbus.exceptions.DBusException, org.freedesktop.dbus.messages.DBusSignal, org.freedesktop.dbus.types.Variant, java.util.List, .Map

A standard properties interface.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Properties.PropertiesChanged

Signal generated when a property changes.

Method Summary

Modifier and TypeMethod and Description
public <
whatever
A
>
A

Returns:

The value of the property (may be any valid DBus type).
Get
(String
The interface this property is associated with.
_interfaceName
,
String
The name of the property.
_propertyName
)

Get the value for the given property.

public Map<String, Variant<?>>

Returns:

The properties mapped to their values.
GetAll
(String
The interface the properties is associated with.
_interfaceName
)

Get all properties and values.

public <
whatever
A
>
void
Set(String
The interface this property is associated with.
_interfaceName
,
String
The name of the property.
_propertyName
,
A
The new value of the property (may be any valid DBus type).
_value
)

Set the value for the given property.

Inherited from org.freedesktop.dbus.interfaces.DBusInterface:
getObjectPathisRemote

Method Detail

Getback to summary
public <A> A Get(String _interfaceName, String _propertyName)

Get the value for the given property.

Parameters
<A>
whatever
_interfaceName:String

The interface this property is associated with.

_propertyName:String

The name of the property.

Returns:A

The value of the property (may be any valid DBus type).

GetAllback to summary
public Map<String, Variant<?>> GetAll(String _interfaceName)

Get all properties and values.

Parameters
_interfaceName:String

The interface the properties is associated with.

Returns:Map<String, Variant<?>>

The properties mapped to their values.

Setback to summary
public <A> void Set(String _interfaceName, String _propertyName, A _value)

Set the value for the given property.

Parameters
<A>
whatever
_interfaceName:String

The interface this property is associated with.

_propertyName:String

The name of the property.

_value:A

The new value of the property (may be any valid DBus type).

org.freedesktop.dbus.interfaces back to summary

public Class Properties.PropertiesChanged

extends DBusSignal
Class Inheritance

Signal generated when a property changes.

Field Summary

Modifier and TypeField and Description
private final String
private final Map<String, Variant<?>>
private final List<String>

Constructor Summary

AccessConstructor and Description
public
PropertiesChanged(String _path, String _interfaceName, Map<String, Variant<?>> _propertiesChanged, List<String> _propertiesRemoved)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

String
getInterfaceName
()

Get name of the interface created this signal (e.g. org.bluez.Adapter1).

public Map<String, Variant<?>>

Returns:

Map
getPropertiesChanged
()

Return the changed properties.

public List<String>

Returns:

List
getPropertiesRemoved
()

Returns a list of removed property keys.

public String
toString()

Overrides org.freedesktop.dbus.messages.Message.toString.

Formats the message in a human-readable format.

Inherited from org.freedesktop.dbus.messages.DBusSignal:
appendbodycreateReal

Field Detail

interfaceNameback to summary
private final String interfaceName
propertiesChangedback to summary
private final Map<String, Variant<?>> propertiesChanged
propertiesRemovedback to summary
private final List<String> propertiesRemoved

Constructor Detail

PropertiesChangedback to summary
public PropertiesChanged(String _path, String _interfaceName, Map<String, Variant<?>> _propertiesChanged, List<String> _propertiesRemoved) throws DBusException

Method Detail

getInterfaceNameback to summary
public String getInterfaceName()

Get name of the interface created this signal (e.g. org.bluez.Adapter1).

Returns:String

String

getPropertiesChangedback to summary
public Map<String, Variant<?>> getPropertiesChanged()

Return the changed properties. Key is the properties name, value is Variant containing any type.

Returns:Map<String, Variant<?>>

Map

getPropertiesRemovedback to summary
public List<String> getPropertiesRemoved()

Returns a list of removed property keys.

Returns:List<String>

List

toStringback to summary
public String toString()

Overrides org.freedesktop.dbus.messages.Message.toString.

Doc from org.freedesktop.dbus.messages.Message.toString.

Formats the message in a human-readable format.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override