Module org.freedesktop.dbus
Package org.freedesktop.dbus

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.

  • Field Details

    • SIGNALTYPEMAP

      private static final Map<String,Class<? extends DBusSignal>> SIGNALTYPEMAP
      Deprecated, for removal: This API element is subject to removal in a future version.

    • MATCHRULE_EQUALS_OPERATIONS

      private static final List<Function<DBusMatchRule,String>> MATCHRULE_EQUALS_OPERATIONS
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

  • Method Details

    • legacyCompat

      static Map<MatchRuleField,String> legacyCompat(Class<?> _c, String _sender, String _path, String _type, String _member) throws DBusException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      DBusException

    • 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