Top Description Fields Constructors Methods
org.freedesktop.dbus

public Class DBusMatchRule

extends Object
Class Inheritance
Imports
org.freedesktop.dbus.exceptions.DBusException, .DBusExecutionException, org.freedesktop.dbus.interfaces.DBusInterface, org.freedesktop.dbus.messages.DBusSignal, .Error, .Message, .MethodCall, .MethodReturn, org.freedesktop.dbus.utils.DBusNamingUtil, .Util, java.util.List, .Map, .Objects, java.util.concurrent.ConcurrentHashMap, java.util.function.Function

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

Field Summary

Modifier and TypeField and Description
private final String
private static final List<Function<DBusMatchRule, String>>
MATCHRULE_EQUALS_OPERATIONS

Equals operations used in matches(DBusMatchRule, boolean) - do not change order!

private final String
private static final String
private static final String
private static final String
private static final String
private final String
private static final List<Function<DBusSignal, String>>
SIGNAL_EQUALS_OPERATIONS

Equals operations used in matches(DBusSignal, boolean) - do not change order!

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

Constructor Summary

AccessConstructor and Description
public
DBusMatchRule(String _type, String _iface, String _member)

public
DBusMatchRule(String _type, String _iface, String _member, String _object)

public
public
public
DBusMatchRule(Class<? extends DBusInterface> _c, String _method)

pack-priv
DBusMatchRule(Class<? extends Object> _c, String _source, String _object, String _type, String _member)

public
DBusMatchRule(Class<? extends Object> _c, String _source, String _object)

public
DBusMatchRule(Class<? extends Object> _c)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
public boolean
equals(Object
the reference object with which to compare.
_obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public static Class<? extends DBusSignal>
public String
public String
public String
public String
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean

Returns:

true if matching
matches
(DBusMatchRule
rule to compare
_rule
,
boolean
true to get an exact match, false to allow partial matches
_strict
)

Checks if the given rule matches with our rule.

public boolean

Returns:

true if matching
matches
(DBusSignal
signal to compare
_signal
,
boolean
true to get an exact match, false to allow partial matches
_strict
)

Checks if the given signal matches with our rule.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

ifaceback to summary
private final String iface
MATCHRULE_EQUALS_OPERATIONSback to summary
private static final List<Function<DBusMatchRule, String>> MATCHRULE_EQUALS_OPERATIONS

Equals operations used in matches(DBusMatchRule, boolean) - do not change order!

memberback to summary
private final String member
MSG_TYPE_ERRORback to summary
private static final String MSG_TYPE_ERROR
MSG_TYPE_METHOD_CALLback to summary
private static final String MSG_TYPE_METHOD_CALL
MSG_TYPE_METHOD_REPLYback to summary
private static final String MSG_TYPE_METHOD_REPLY
MSG_TYPE_SIGNALback to summary
private static final String MSG_TYPE_SIGNAL
objectback to summary
private final String object
SIGNAL_EQUALS_OPERATIONSback to summary
private static final List<Function<DBusSignal, String>> SIGNAL_EQUALS_OPERATIONS

Equals operations used in matches(DBusSignal, boolean) - do not change order!

SIGNALTYPEMAPback to summary
private static final Map<String, Class<? extends DBusSignal>> SIGNALTYPEMAP
sourceback to summary
private final String source
typeback to summary
private final String type

Constructor Detail

DBusMatchRuleback to summary
public DBusMatchRule(String _type, String _iface, String _member)
DBusMatchRuleback to summary
public DBusMatchRule(String _type, String _iface, String _member, String _object)
DBusMatchRuleback to summary
public DBusMatchRule(DBusExecutionException _e) throws DBusException
DBusMatchRuleback to summary
public DBusMatchRule(Message _m)
DBusMatchRuleback to summary
public DBusMatchRule(Class<? extends DBusInterface> _c, String _method) throws DBusException
DBusMatchRuleback to summary
pack-priv DBusMatchRule(Class<? extends Object> _c, String _source, String _object, String _type, String _member) throws DBusException
Annotations
@SuppressWarnings:unchecked
DBusMatchRuleback to summary
public DBusMatchRule(Class<? extends Object> _c, String _source, String _object) throws DBusException
DBusMatchRuleback to summary
public DBusMatchRule(Class<? extends Object> _c) throws DBusException

Method Detail

assertDBusInterfaceback to summary
pack-priv void assertDBusInterface(String _str) throws DBusException
equalsback to summary
public boolean equals(Object _obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
_obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getCachedSignalTypeback to summary
public static Class<? extends DBusSignal> getCachedSignalType(String _type)
getInterfaceback to summary
public String getInterface()
getMemberback to summary
public String getMember()
getObjectback to summary
public String getObject()
getSourceback to summary
public String getSource()
getTypeback to summary
public String getType()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
matchesback to summary
public boolean matches(DBusMatchRule _rule, boolean _strict)

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:DBusMatchRule

rule to compare

_strict:boolean

true to get an exact match, false to allow partial matches

Returns:boolean

true if matching

matchesback to summary
public boolean matches(DBusSignal _signal, boolean _strict)

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:DBusSignal

signal to compare

_strict:boolean

true to get an exact match, false to allow partial matches

Returns:boolean

true if matching

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override