OSGi 8.1.0 · org.osgi.framework.Filter · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: If the other object is a `Filter` object, then returns the result of calling `this.toString().equals(obj.toString())`; `false` otherwise. equals(Object The object to compare against this `Filter`. obj) Compares this `Filter` to another `Filter`.
public int	Returns: The hashCode of this `Filter`. hashCode() Returns the hashCode for this `Filter`.
public boolean	Returns: `true` if the service's properties match this `Filter`; `false` otherwise. match(ServiceReference<?> The reference to the service whose properties are used in the match. reference) Filter using a service's properties.
public boolean	Returns: `true` if the `Dictionary`'s values match this filter; `false` otherwise. match(Dictionary<String, ?> The `Dictionary` whose key/value pairs are used in the match. dictionary) Filter using a `Dictionary` with case insensitive key lookup.
public boolean	Returns: `true` if the `Dictionary`'s values match this filter; `false` otherwise. matchCase(Dictionary<String, ?> The `Dictionary` whose key/value pairs are used in the match. dictionary) Filter using a `Dictionary`.
public boolean	Returns: `true` if the `Map`'s values match this filter; `false` otherwise. matches(Map<String, ?> The `Map` whose key/value pairs are used in the match. Maps with `null` key or values are not supported. A `null` value is considered not present to the filter. map) Filter using a `Map`.
public String	Returns: This `Filter`'s filter string. toString() Returns this `Filter`'s filter string.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Compares this `Filter` to another `Filter`. This implementation returns the result of calling `this.toString().equals(obj.toString())`. Parameters obj:Object The object to compare against this `Filter`. Returns:boolean If the other object is a `Filter` object, then returns the result of calling `this.toString().equals(obj.toString())`; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Compares this Filter to another Filter.

This implementation returns the result of calling this.toString().equals(obj.toString()).

Parameters

obj:Object: The object to compare against this Filter.

Returns:boolean

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

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Returns the hashCode for this `Filter`. This implementation returns the result of calling `this.toString().hashCode()`. Returns:int The hashCode of this `Filter`. Annotations @Override

public int hashCode()

Returns the hashCode for this Filter.

This implementation returns the result of calling this.toString().hashCode().

Returns:int

The hashCode of this Filter.

Annotations

@Override

match back to summary

match	back to summary
public boolean match(ServiceReference<?> reference) Filter using a service's properties. This `Filter` is executed using the keys and values of the referenced service's properties. The keys are looked up in a case insensitive manner. Parameters reference:ServiceReference<?> The reference to the service whose properties are used in the match. Returns:boolean `true` if the service's properties match this `Filter`; `false` otherwise.

public boolean match(ServiceReference<?> reference)

Filter using a service's properties.

This Filter is executed using the keys and values of the referenced service's properties. The keys are looked up in a case insensitive manner.

Parameters

reference:ServiceReference<?>: The reference to the service whose properties are used in the match.

Returns:boolean

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

match back to summary

match	back to summary
public boolean match(Dictionary<String, ?> dictionary) Filter using a `Dictionary` with case insensitive key lookup. This `Filter` is executed using the specified `Dictionary`'s keys and values. The keys are looked up in a case insensitive manner. Parameters dictionary:Dictionary<String, ?> The `Dictionary` whose key/value pairs are used in the match. Returns:boolean `true` if the `Dictionary`'s values match this filter; `false` otherwise. Exceptions IllegalArgumentException: If `dictionary` contains case variants of the same key name.

public boolean match(Dictionary<String, ?> dictionary)

Filter using a Dictionary with case insensitive key lookup. This Filter is executed using the specified Dictionary's keys and values. The keys are looked up in a case insensitive manner.

Parameters

dictionary:Dictionary<String, ?>: The Dictionary whose key/value pairs are used in the match.

Returns:boolean

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

Exceptions

IllegalArgumentException:: If dictionary contains case variants of the same key name.

matchCase back to summary

matchCase	back to summary
public boolean matchCase(Dictionary<String, ?> dictionary) Filter using a `Dictionary`. This `Filter` is executed using the specified `Dictionary`'s keys and values. The keys are looked up in a normal manner respecting case. Parameters dictionary:Dictionary<String, ?> The `Dictionary` whose key/value pairs are used in the match. Returns:boolean `true` if the `Dictionary`'s values match this filter; `false` otherwise. Since 1.3

public boolean matchCase(Dictionary<String, ?> dictionary)

Filter using a Dictionary. This Filter is executed using the specified Dictionary's keys and values. The keys are looked up in a normal manner respecting case.

Parameters

dictionary:Dictionary<String, ?>: The Dictionary whose key/value pairs are used in the match.

Returns:boolean

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

Since

1.3

matches back to summary

matches	back to summary
public boolean matches(Map<String, ?> map) Filter using a `Map`. This `Filter` is executed using the specified `Map`'s keys and values. The keys are looked up in a normal manner respecting case. Parameters map:Map<String, ?> The `Map` whose key/value pairs are used in the match. Maps with `null` key or values are not supported. A `null` value is considered not present to the filter. Returns:boolean `true` if the `Map`'s values match this filter; `false` otherwise. Since 1.6

public boolean matches(Map<String, ?> map)

Filter using a Map. This Filter is executed using the specified Map's keys and values. The keys are looked up in a normal manner respecting case.

Parameters

map:Map<String, ?>: The Map whose key/value pairs are used in the match. Maps with null key or values are not supported. A null value is considered not present to the filter.

Returns:boolean

true if the Map's values match this filter; false otherwise.

Since

1.6

toString back to summary

toString	back to summary
public String toString() Returns this `Filter`'s filter string. The filter string is normalized by removing whitespace which does not affect the meaning of the filter. Returns:String This `Filter`'s filter string. Annotations @Override

public String toString()

Returns this Filter's filter string.

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

Returns:String

This Filter's filter string.

Annotations

@Override

public Interface Filter

Method Summary

Method Detail