Package org.freedesktop.dbus

Class DBusMatchRule

java.lang.Object

org.freedesktop.dbus.DBusMatchRule

public class DBusMatchRule
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
private final String	iface
private static final Pattern	IFACE_PATTERN
private static final List<Function<DBusMatchRule,String>>	MATCHRULE_EQUALS_OPERATIONS	Equals operations used in matches(DBusMatchRule, boolean) - do not change order!
private final String	member
private final String	object
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>>	SIGNALTYPEMAP
private final String	source
private final String	type

Constructor Summary

Constructors

Constructor	Description
DBusMatchRule(Class<? extends Object> _c)
DBusMatchRule(Class<? extends Object> _c, String _source, String _object)
DBusMatchRule(Class<? extends Object> _c, String _source, String _object, String _type, String _member)
DBusMatchRule(Class<? extends DBusInterface> _c, String _method)
DBusMatchRule(String _type, String _iface, String _member)
DBusMatchRule(String _type, String _iface, String _member, String _object)
DBusMatchRule(DBusExecutionException _e)
DBusMatchRule(Message _m)

Method Summary

Modifier and Type	Method	Description
(package private) void	assertDBusInterface(String _str)
boolean	equals(Object _obj)
static Class<? extends DBusSignal>	getCachedSignalType(String _type)
String	getInterface()
String	getMember()
String	getObject()
String	getSource()
String	getType()
int	hashCode()
boolean	matches(DBusMatchRule _rule, boolean _strict)	Checks if the given rule matches with our rule.
boolean	matches(DBusSignal _signal, boolean _strict)	Checks if the given signal matches with our rule.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

IFACE_PATTERN

private static final Pattern IFACE_PATTERN

SIGNALTYPEMAP

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

MATCHRULE_EQUALS_OPERATIONS

private static final List<Function<DBusMatchRule,String>> MATCHRULE_EQUALS_OPERATIONS

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

SIGNAL_EQUALS_OPERATIONS

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

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

type

private final String type

iface

private final String iface

member

private final String member

object

private final String object

source

private final String source

Constructor Details

DBusMatchRule

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

DBusMatchRule

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

DBusMatchRule

public DBusMatchRule(DBusExecutionException _e)
              throws DBusException

Throws:

DBusException

DBusMatchRule

public DBusMatchRule(Message _m)

DBusMatchRule

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

Throws:

DBusException

DBusMatchRule

DBusMatchRule(Class<? extends Object> _c,
 String _source,
 String _object,
 String _type,
 String _member)
       throws DBusException

Throws:

DBusException

DBusMatchRule

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

Throws:

DBusException

DBusMatchRule

public DBusMatchRule(Class<? extends Object> _c)
              throws DBusException

Throws:

DBusException

Method Details

getCachedSignalType

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

assertDBusInterface

void assertDBusInterface(String _str)
                  throws DBusException

Throws:

DBusException

matches

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 - rule to compare

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

Returns:

true if matching

matches

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 - signal to compare

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

Returns:

true if matching

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object _obj)

Overrides:

equals in class Object

getType

public String getType()

getInterface

public String getInterface()

getMember

public String getMember()

getSource

public String getSource()

getObject

public String getObject()