Class DBusMatchRule

java.lang.Object

org.freedesktop.dbus.matchrules.DBusMatchRule

org.freedesktop.dbus.DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-03")
public final class DBusMatchRule
extends DBusMatchRule

Deprecated, for removal: This API element is subject to removal in a future version.

use DBusMatchRuleBuilder

Defined a rule to match a message.
This is mainly used to handle / take actions when signals arrive.

Constructor Summary

Constructors

Constructor	Description
DBusMatchRule(Class<?> _c)	Deprecated, for removal: This API element is subject to removal in a future version.
DBusMatchRule(Class<?> _c, String _source, String _object)	Deprecated, for removal: This API element is subject to removal in a future version.
DBusMatchRule(Class<? extends DBusInterface> _c, String _method)	Deprecated, for removal: This API element is subject to removal in a future version.
DBusMatchRule(String _type, String _iface, String _member)	Deprecated, for removal: This API element is subject to removal in a future version.
DBusMatchRule(String _type, String _iface, String _member, String _path)	Deprecated, for removal: This API element is subject to removal in a future version.
DBusMatchRule(String _type, String _iface, String _member, String _path, String _destination)	Deprecated, for removal: This API element is subject to removal in a future version.
DBusMatchRule(DBusExecutionException _e)	Deprecated, for removal: This API element is subject to removal in a future version.
DBusMatchRule(Message _m)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static Class<? extends DBusSignal>	getCachedSignalType(String _type)	Deprecated, for removal: This API element is subject to removal in a future version. use DBusMatchRule.getCachedSignalType(String)
String	getObject()	Deprecated, for removal: This API element is subject to removal in a future version. use DBusMatchRule.getPath()
String	getSource()	Deprecated, for removal: This API element is subject to removal in a future version. use DBusMatchRule.getSender()
boolean	matches(DBusMatchRule _rule, boolean _strict)	Deprecated, for removal: This API element is subject to removal in a future version. using a MatchRule to match against a MatchRule makes no sense, therefore this method will be removed without any replacement
boolean	matches(DBusSignal _signal, boolean _strict)	Deprecated, for removal: This API element is subject to removal in a future version. Checks if the given signal matches with our rule.

Methods inherited from class DBusMatchRule

equals, getArg0123, getArg0123Path, getDestination, getInterface, getMember, getMessageType, getPath, getSender, hashCode, matches, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public DBusMatchRule(String _type,
 String _iface,
 String _member)

Deprecated, for removal: This API element is subject to removal in a future version.

DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public DBusMatchRule(String _type,
 String _iface,
 String _member,
 String _path)

Deprecated, for removal: This API element is subject to removal in a future version.

DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public DBusMatchRule(String _type,
 String _iface,
 String _member,
 String _path,
 String _destination)

Deprecated, for removal: This API element is subject to removal in a future version.

DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public DBusMatchRule(DBusExecutionException _e)
              throws DBusException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

DBusException

DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public DBusMatchRule(Message _m)

Deprecated, for removal: This API element is subject to removal in a future version.

DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public DBusMatchRule(Class<? extends DBusInterface> _c,
 String _method)
              throws DBusException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

DBusException

DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public DBusMatchRule(Class<?> _c,
 String _source,
 String _object)
              throws DBusException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

DBusException

DBusMatchRule

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public DBusMatchRule(Class<?> _c)
              throws DBusException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

DBusException

Method Details

getCachedSignalType

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-03")
public static Class<? extends DBusSignal> getCachedSignalType(String _type)

Deprecated, for removal: This API element is subject to removal in a future version.

use DBusMatchRule.getCachedSignalType(String)

matches

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public boolean matches(DBusMatchRule _rule,
 @Deprecated(forRemoval=true,since="5.2.0 - 2025-05-01")
 boolean _strict)

Deprecated, for removal: This API element is subject to removal in a future version.

using a MatchRule to match against a MatchRule makes no sense, therefore this method will be removed without any replacement

Checks if the given rule matches with our rule.

Method supports partial matching by setting strict to false. Partial means that only the parts of this object are compared to the given object which were set (non-null) on ourselves. Fields set on the given object but not on ourselves will be ignored.

Parameters:

_rule - rule to compare

_strict - deprecated, no longer used, will be removed in future

Returns:

true if matching

matches

public boolean matches(DBusSignal _signal,
 @Deprecated(forRemoval=true,since="5.2.0 - 2025-05-01")
 boolean _strict)

Deprecated, for removal: This API element is subject to removal in a future version.

Checks if the given signal matches with our rule.

Method supports partial matching by setting strict to false. Partial means that only the parts of this rule are compared to the given signal which were set (non-null) on ourselves. Fields set on the given signal but not on ourselves will be ignored.

Parameters:

_signal - signal to compare

_strict - deprecated, no longer used, will be removed in future

Returns:

true if matching

getSource

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public String getSource()

Deprecated, for removal: This API element is subject to removal in a future version.

use DBusMatchRule.getSender()

Returns:

sender

getObject

@Deprecated(forRemoval=true,
            since="5.2.0 - 2025-05-01")
public String getObject()

Deprecated, for removal: This API element is subject to removal in a future version.

use DBusMatchRule.getPath()

Returns:

path