Package org.apache.felix.utils.filter
Class FilterImpl
java.lang.Object
org.apache.felix.utils.filter.FilterImpl
- All Implemented Interfaces:
org.osgi.framework.Filter
This filter implementation is based on the official OSGi filter with additional
support for the SUPERSET (>*) and SUBSET (<*) operators.
This filter also has a few optimizations (cached transformation).
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
This Dictionary is used for case-insensitive key lookup during filter evaluation.private static class
Parser class for OSGi filter strings.private static class
This Dictionary is used for key lookup from a ServiceReference during filter evaluation.private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private static final int
private final String
filter attribute or null if operation AND, OR or NOTprivate static final Class[]
private final Object
optim in case of versionprivate static final int
private String
private static final int
private static final int
private static final int
private final int
filter operationprivate static final int
private static final int
private static final int
private static final int
private static final int
private final Object
filter operands -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static String
approxString
(String input) Map a string for an APPROX (~=) comparison.private boolean
private boolean
compare_Boolean
(int operation, boolean boolval, Object value2) private boolean
compare_Byte
(int operation, byte byteval, Object value2) private boolean
compare_Character
(int operation, char charval, Object value2) private boolean
compare_Collection
(int operation, Collection collection, Object value2) private boolean
compare_Comparable
(int operation, Comparable value1, Object value2) private boolean
compare_Double
(int operation, double doubleval, Object value2) private boolean
compare_Float
(int operation, float floatval, Object value2) private boolean
compare_Integer
(int operation, int intval, Object value2) private boolean
compare_Long
(int operation, long longval, Object value2) private boolean
compare_ObjectArray
(int operation, Object[] array, Object value2) private boolean
compare_PrimitiveArray
(int operation, Class type, Object primarray, Object value2) private boolean
compare_Short
(int operation, short shortval, Object value2) private boolean
compare_String
(int operation, String string, Object value2) private boolean
compare_Unknown
(int operation, Object value1, Object value2) private static String
encodeValue
(String value) Encode the value string such that '(', '*', ')' and '\' are escaped.boolean
Compares thisFilter
to anotherFilter
.private Collection
int
hashCode()
Returns the hashCode for thisFilter
.boolean
match
(Dictionary dictionary) Filter using aDictionary
.boolean
match
(org.osgi.framework.ServiceReference reference) Filter using a service's properties.private boolean
match0
(Dictionary properties) Internal match routine.private boolean
boolean
matchCase
(Dictionary dictionary) Filter with case sensitivity using aDictionary
.boolean
Filter using aMap
.boolean
Filter using aMap
.static FilterImpl
newInstance
(String filterString) Constructs aFilterImpl
object.static FilterImpl
newInstance
(String filterString, boolean ignoreCase) private String
Returns thisFilter
's normalized filter string.toString()
Returns thisFilter
's filter string.
-
Field Details
-
EQUAL
private static final int EQUAL- See Also:
-
APPROX
private static final int APPROX- See Also:
-
GREATER
private static final int GREATER- See Also:
-
LESS
private static final int LESS- See Also:
-
PRESENT
private static final int PRESENT- See Also:
-
SUBSTRING
private static final int SUBSTRING- See Also:
-
AND
private static final int AND- See Also:
-
OR
private static final int OR- See Also:
-
NOT
private static final int NOT- See Also:
-
SUBSET
private static final int SUBSET- See Also:
-
SUPERSET
private static final int SUPERSET- See Also:
-
op
private final int opfilter operation -
attr
filter attribute or null if operation AND, OR or NOT -
value
filter operands -
converted
optim in case of version -
filterString
-
constructorType
-
-
Constructor Details
-
FilterImpl
-
-
Method Details
-
newInstance
public static FilterImpl newInstance(String filterString) throws org.osgi.framework.InvalidSyntaxException Constructs aFilterImpl
object. This filter object may be used to match aServiceReference
or a Dictionary.If the filter cannot be parsed, an
InvalidSyntaxException
will be thrown with a human readable message where the filter became unparsable.- Parameters:
filterString
- the filter string.- Returns:
- A new filter
- Throws:
org.osgi.framework.InvalidSyntaxException
- If the filter parameter contains an invalid filter string that cannot be parsed.
-
newInstance
public static FilterImpl newInstance(String filterString, boolean ignoreCase) throws org.osgi.framework.InvalidSyntaxException - Throws:
org.osgi.framework.InvalidSyntaxException
-
match
public boolean match(org.osgi.framework.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 case insensitively matched with thisFilter
.- Specified by:
match
in interfaceorg.osgi.framework.Filter
- Parameters:
reference
- The reference to the service whose properties are used in the match.- Returns:
true
if the service's properties match thisFilter
;false
otherwise.
-
match
Filter using aDictionary
. ThisFilter
is executed using the specifiedDictionary
's keys and values. The keys are case insensitively matched with thisFilter
.- Specified by:
match
in interfaceorg.osgi.framework.Filter
- Parameters:
dictionary
- TheDictionary
whose keys are used in the match.- Returns:
true
if theDictionary
's keys and values match this filter;false
otherwise.- Throws:
IllegalArgumentException
- Ifdictionary
contains case variants of the same key name.
-
matchCase
Filter with case sensitivity using aDictionary
. ThisFilter
is executed using the specifiedDictionary
's keys and values. The keys are case sensitively matched with thisFilter
.- Specified by:
matchCase
in interfaceorg.osgi.framework.Filter
- Parameters:
dictionary
- TheDictionary
whose keys are used in the match.- Returns:
true
if theDictionary
's keys and values match this filter;false
otherwise.- Since:
- 1.3
-
matchCase
Filter using aMap
. ThisFilter
is executed using the specifiedMap
's keys and values. The keys are case insensitively matched with thisFilter
.- Parameters:
map
- TheMap
whose keys are used in the match.- Returns:
true
if theMap
's keys and values match this filter;false
otherwise.- Throws:
IllegalArgumentException
- Ifmap
contains case variants of the same key name.
-
matches
Filter using aMap
. ThisFilter
is executed using the specifiedMap
's keys and values. The keys are looked up in a normal manner respecting case.- Specified by:
matches
in interfaceorg.osgi.framework.Filter
- Parameters:
map
- TheMap
whose key/value pairs are used in the match. Maps withnull
key or values are not supported. Anull
value is considered not present to the filter.- Returns:
true
if theMap
's values match this filter;false
otherwise.- Since:
- 1.6
-
toString
Returns thisFilter
's filter string.The filter string is normalized by removing whitespace which does not affect the meaning of the filter.
-
normalize
Returns thisFilter
's normalized filter string.The filter string is normalized by removing whitespace which does not affect the meaning of the filter.
- Returns:
- This
Filter
's filter string.
-
equals
Compares thisFilter
to anotherFilter
.This implementation returns the result of calling
this.toString().equals(obj.toString()
. -
hashCode
public int hashCode()Returns the hashCode for thisFilter
.This implementation returns the result of calling
this.toString().hashCode()
. -
match0
Internal match routine. Dictionary parameter must support case-insensitive get.- Parameters:
properties
- A dictionary whose keys are used in the match.- Returns:
- If the Dictionary's keys match the filter, return
true
. Otherwise, returnfalse
.
-
match0
-
encodeValue
Encode the value string such that '(', '*', ')' and '\' are escaped.- Parameters:
value
- unencoded value string.- Returns:
- encoded value string.
-
getSet
-
compare
-
compare_Collection
-
compare_ObjectArray
-
compare_PrimitiveArray
-
compare_String
-
compare_Integer
-
compare_Long
-
compare_Byte
-
compare_Short
-
compare_Character
-
compare_Boolean
-
compare_Float
-
compare_Double
-
compare_Comparable
-
compare_Unknown
-
approxString
Map a string for an APPROX (~=) comparison. This implementation removes white spaces. This is the minimum implementation allowed by the OSGi spec.- Parameters:
input
- Input string.- Returns:
- String ready for APPROX comparison.
-