Module org.freedesktop.dbus

Package org.freedesktop.dbus.matchrules

Class DBusMatchRule

java.lang.Object

org.freedesktop.dbus.matchrules.DBusMatchRule

Direct Known Subclasses:

DBusMatchRule

public sealed class DBusMatchRule
extends Object
permits DBusMatchRule

Represents a DBus matchrule.
Use DBusMatchRuleBuilder to create instances of this class.

Since:

5.2.0 - 2025-05-03

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<MatchRuleField,String>	fields
private final Map<MatchRuleField,Map<Integer,String>>	multiValueFields
private static final Map<String,Class<? extends DBusSignal>>	SIGNALTYPEMAP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DBusMatchRule(Map<MatchRuleField,String> _values, Map<MatchRuleField,Map<Integer,String>> _multiValues)

Method Summary

Modifier and Type	Method	Description
(package private) static void	addToTypeMap(String _key, Class<? extends DBusSignal> _clz)
boolean	equals(Object _obj)
(package private) static String	formatValue(String _val)	Ensures escaping of values in match rule.
Map<Integer,String>	getArg0123()
Map<Integer,String>	getArg0123Path()
static Class<? extends DBusSignal>	getCachedSignalType(String _type)
String	getDestination()
String	getInterface()
String	getMember()
String	getMessageType()
private Map<Integer,String>	getMultiValue(MatchRuleField _field)
String	getPath()
String	getSender()
int	hashCode()
boolean	matches(Message _msg)	Checks if the given rule matches with our rule.
String	toString()	Converts this DBusMatchRule to a match rule string as required to use for DBus.addMatch(String) method.

Methods inherited from class java.lang.Object

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

Field Details

SIGNALTYPEMAP

private static final Map<String,Class<? extends DBusSignal>> SIGNALTYPEMAP

fields

private final Map<MatchRuleField,String> fields

multiValueFields

private final Map<MatchRuleField,Map<Integer,String>> multiValueFields

Constructor Details

DBusMatchRule

protected DBusMatchRule(Map<MatchRuleField,String> _values,
 Map<MatchRuleField,Map<Integer,String>> _multiValues)

Method Details

getMessageType

public String getMessageType()

getInterface

public String getInterface()

getMember

public String getMember()

getSender

public String getSender()

getPath

public String getPath()

getDestination

public String getDestination()

getArg0123

public Map<Integer,String> getArg0123()

getArg0123Path

public Map<Integer,String> getArg0123Path()

getMultiValue

private Map<Integer,String> getMultiValue(MatchRuleField _field)

matches

public boolean matches(Message _msg)

Checks if the given rule matches with our rule.

Parameters:

_msg - message to match against the configure rule

Returns:

true if matching

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object _obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this DBusMatchRule to a match rule string as required to use for DBus.addMatch(String) method.

Overrides:

toString in class Object

formatValue

static String formatValue(String _val)

Ensures escaping of values in match rule.

Parameters:

_val - value to escape

Returns:

escaped string or input if nothing to do

getCachedSignalType

public static Class<? extends DBusSignal> getCachedSignalType(String _type)

addToTypeMap

static void addToTypeMap(String _key,
 Class<? extends DBusSignal> _clz)