org.osgi.framework

Interface Filter

All Known Implementing Classes:

FilterImpl

public interface Filter

An RFC 1960-based Filter.

Filter objects can be created by calling BundleContext.createFilter(java.lang.String) with the chosen filter string.

A Filter object can be used numerous times to determine if the match argument matches the filter string that was used to create the Filter object.

Some examples of LDAP filters are:

      "(cn=Babs Jensen)"
      "(!(cn=Tim Howes))"
      "(&(" + Constants.OBJECTCLASS + "=Person)(|(sn=Jensen)(cn=Babs J*)))"
      "(o=univ*of*mich*)"
 

Since:

1.1

See Also:

"Framework specification for a description of the filter string syntax."

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares this Filter object to another object.
int	hashCode() Returns the hashCode for this Filter object.
boolean	match(java.util.Dictionary dictionary) Filter using a Dictionary object.
boolean	match(ServiceReference reference) Filter using a service's properties.
boolean	matchCase(java.util.Dictionary dictionary) Filter with case sensitivity using a Dictionary object.
java.lang.String	toString() Returns this Filter object's filter string.

Method Detail

match

boolean match(ServiceReference reference)

Filter using a service's properties.

The filter is executed using the keys and values of the referenced service's properties. The keys are case insensitively matched with the filter.

Parameters:

reference - The reference to the service whose properties are used in the match.

Returns:

true if the service's properties match this filter; false otherwise.

match

boolean match(java.util.Dictionary dictionary)

Filter using a Dictionary object. The Filter is executed using the Dictionary object's keys and values. The keys are case insensitively matched with the filter.

Parameters:

dictionary - The Dictionary object whose keys are used in the match.

Returns:

true if the Dictionary object's keys and values match this filter; false otherwise.

Throws:

java.lang.IllegalArgumentException - If dictionary contains case variants of the same key name.

toString

java.lang.String toString()

Returns this Filter object's filter string.

The filter string is normalized by removing whitespace which does not affect the meaning of the filter.

Overrides:

toString in class java.lang.Object

Returns:

Filter string.

equals

boolean equals(java.lang.Object obj)

Compares this Filter object to another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare against this Filter object.

Returns:

If the other object is a Filter object, then returns this.toString().equals(obj.toString();false otherwise.

hashCode

int hashCode()

Returns the hashCode for this Filter object.

Overrides:

hashCode in class java.lang.Object

Returns:

The hashCode of the filter string; that is, this.toString().hashCode().

matchCase

boolean matchCase(java.util.Dictionary dictionary)

Filter with case sensitivity using a Dictionary object. The Filter is executed using the Dictionary object's keys and values. The keys are case sensitively matched with the filter.

Parameters:

dictionary - The Dictionary object whose keys are used in the match.

Returns:

true if the Dictionary object's keys and values match this filter; false otherwise.

Since:

1.3