java.lang.Object | |
↳ | android.content.IntentFilter |
Structured description of Intent values to be matched. An IntentFilter can match against actions, categories, and data (either via its type, scheme, and/or path) in an Intent. It also includes a "priority" value which is used to order multiple matching filters.
IntentFilter objects are often created in XML as part of a package's
AndroidManifest.xml
file,
using intent-filter
tags.
There are three Intent characteristics you can filter on: the
action, data, and categories. For each of these
characteristics you can provide
multiple possible matching values (via addAction(String)
,
addDataType(String)
, addDataScheme(String)
, addDataSchemeSpecificPart(String, int)
,
addDataAuthority(String, String)
, addDataPath(String, int)
, and addCategory(String)
, respectively).
For actions, the field
will not be tested if no values have been given (treating it as a wildcard);
if no data characteristics are specified, however, then the filter will
only match intents that contain no data.
The data characteristic is itself divided into three attributes: type, scheme, authority, and path. Any that are specified must match the contents of the Intent. If you specify a scheme but no type, only Intent that does not have a type (such as mailto:) will match; a content: URI will never match because they always have a MIME type that is supplied by their content provider. Specifying a type with no scheme has somewhat special meaning: it will match either an Intent with no URI field, or an Intent with a content: or file: URI. If you specify neither, then only an Intent with no data or type will match. To specify an authority, you must also specify one or more schemes that it is associated with. To specify a path, you also must specify both one or more authorities and one or more schemes it is associated with.
For information about how to create and resolve intents, read the Intents and Intent Filters developer guide.
A match is based on the following rules. Note that
for an IntentFilter to match an Intent, three conditions must hold:
the action and category must match, and
the data (both the data type and
data scheme+authority+path if specified) must match
(see match(ContentResolver, Intent, boolean, String)
for more details
on how the data fields match).
Action matches if any of the given values match the Intent action; if the filter specifies no actions, then it will only match Intents that do not contain an action.
Data Type matches if any of the given values match the
Intent type. The Intent
type is determined by calling resolveType(ContentResolver)
. A wildcard can be
used for the MIME sub-type, in both the Intent and IntentFilter, so that the
type "audio/*" will match "audio/mpeg", "audio/aiff", "audio/*", etc.
Note that MIME type matching here is case sensitive, unlike
formal RFC MIME types! You should thus always use lower case letters
for your MIME types.
Data Scheme matches if any of the given values match the
Intent data's scheme.
The Intent scheme is determined by calling getData()
and getScheme()
on that URI.
Note that scheme matching here is case sensitive, unlike
formal RFC schemes! You should thus always use lower case letters
for your schemes.
Data Scheme Specific Part matches if any of the given values match
the Intent's data scheme specific part and one of the data schemes in the filter
has matched the Intent, or no scheme specific parts were supplied in the filter.
The Intent scheme specific part is determined by calling
getData()
and getSchemeSpecificPart()
on that URI.
Note that scheme specific part matching is case sensitive.
Data Authority matches if any of the given values match
the Intent's data authority and one of the data schemes in the filter
has matched the Intent, or no authories were supplied in the filter.
The Intent authority is determined by calling
getData()
and getAuthority()
on that URI.
Note that authority matching here is case sensitive, unlike
formal RFC host names! You should thus always use lower case letters
for your authority.
Data Path matches if any of the given values match the
Intent's data path and both a scheme and authority in the filter
has matched against the Intent, or no paths were supplied in the
filter. The Intent authority is determined by calling
getData()
and getPath()
on that URI.
Categories match if all of the categories in the Intent match categories given in the filter. Extra categories in the filter that are not in the Intent will not cause the match to fail. Note that unlike the action, an IntentFilter with no categories will only match an Intent that does not have any categories.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
IntentFilter.AuthorityEntry | This is an entry for a single authority in the Iterator returned by
authoritiesIterator() . |
||||||||||
IntentFilter.MalformedMimeTypeException | This exception is thrown when a given MIME type does not have a valid syntax. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | MATCH_ADJUSTMENT_MASK | The part of a match constant that applies a quality adjustment to the basic category of match. | |||||||||
int | MATCH_ADJUSTMENT_NORMAL | Quality adjustment applied to the category of match that signifies the default, base value; higher numbers improve the quality while lower numbers reduce it. | |||||||||
int | MATCH_CATEGORY_EMPTY | The filter matched an intent that had no data specified. | |||||||||
int | MATCH_CATEGORY_HOST | The filter matched an intent with the same data URI scheme and authority host. | |||||||||
int | MATCH_CATEGORY_MASK | The part of a match constant that describes the category of match that occurred. | |||||||||
int | MATCH_CATEGORY_PATH | The filter matched an intent with the same data URI scheme, authority, and path. | |||||||||
int | MATCH_CATEGORY_PORT | The filter matched an intent with the same data URI scheme and authority host and port. | |||||||||
int | MATCH_CATEGORY_SCHEME | The filter matched an intent with the same data URI scheme. | |||||||||
int | MATCH_CATEGORY_SCHEME_SPECIFIC_PART | The filter matched an intent with the same data URI scheme and scheme specific part. | |||||||||
int | MATCH_CATEGORY_TYPE | The filter matched an intent with the same data MIME type. | |||||||||
int | NO_MATCH_ACTION | The filter didn't match due to different actions. | |||||||||
int | NO_MATCH_CATEGORY | The filter didn't match because it required one or more categories that were not in the Intent. | |||||||||
int | NO_MATCH_DATA | The filter didn't match due to different data URIs. | |||||||||
int | NO_MATCH_TYPE | The filter didn't match due to different MIME types. | |||||||||
int | SYSTEM_HIGH_PRIORITY | The filter setPriority(int) value at which system high-priority
receivers are placed; that is, receivers that should execute before
application code. |
|||||||||
int | SYSTEM_LOW_PRIORITY | The filter setPriority(int) value at which system low-priority
receivers are placed; that is, receivers that should execute after
application code. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CREATOR |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
New empty IntentFilter.
| |||||||||||
New IntentFilter that matches a single action with no data.
| |||||||||||
New IntentFilter that matches a single action and data type.
| |||||||||||
New IntentFilter containing a copy of an existing filter.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return an iterator over the filter's actions.
| |||||||||||
Add a new Intent action to match against.
| |||||||||||
Add a new Intent category to match against.
| |||||||||||
Add a new Intent data authority to match against.
| |||||||||||
Add a new Intent data path to match against.
| |||||||||||
Add a new Intent data scheme to match against.
| |||||||||||
Add a new Intent data "scheme specific part" to match against.
| |||||||||||
Add a new Intent data type to match against.
| |||||||||||
Return an iterator over the filter's data authorities.
| |||||||||||
Return an iterator over the filter's categories.
| |||||||||||
Return the number of actions in the filter.
| |||||||||||
Return the number of categories in the filter.
| |||||||||||
Return the number of data authorities in the filter.
| |||||||||||
Return the number of data paths in the filter.
| |||||||||||
Return the number of data scheme specific parts in the filter.
| |||||||||||
Return the number of data schemes in the filter.
| |||||||||||
Return the number of data types in the filter.
| |||||||||||
Create a new IntentFilter instance with a specified action and MIME
type, where you know the MIME type is correctly formatted.
| |||||||||||
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
| |||||||||||
Return an action in the filter.
| |||||||||||
Return a category in the filter.
| |||||||||||
Return a data authority in the filter.
| |||||||||||
Return a data path in the filter.
| |||||||||||
Return a data scheme in the filter.
| |||||||||||
Return a data scheme specific part in the filter.
| |||||||||||
Return a data type in the filter.
| |||||||||||
Return the priority of this filter.
| |||||||||||
Is the given action included in the filter? Note that if the filter
does not include any actions, false will always be returned.
| |||||||||||
Is the given category included in the filter?
| |||||||||||
Is the given data authority included in the filter? Note that if the
filter does not include any authorities, false will always be
returned.
| |||||||||||
Is the given data path included in the filter? Note that if the
filter does not include any paths, false will always be
returned.
| |||||||||||
Is the given data scheme included in the filter? Note that if the
filter does not include any scheme, false will always be
returned.
| |||||||||||
Is the given data scheme specific part included in the filter? Note that if the
filter does not include any scheme specific parts, false will always be
returned.
| |||||||||||
Is the given data type included in the filter? Note that if the filter
does not include any type, false will always be returned.
| |||||||||||
Test whether this filter matches the given intent.
| |||||||||||
Test whether this filter matches the given intent data.
| |||||||||||
Match this filter against an Intent's action.
| |||||||||||
Match this filter against an Intent's categories.
| |||||||||||
Match this filter against an Intent's data (type, scheme and path).
| |||||||||||
Match this intent filter against the given Intent data.
| |||||||||||
Return an iterator over the filter's data paths.
| |||||||||||
Return an iterator over the filter's data scheme specific parts.
| |||||||||||
Return an iterator over the filter's data schemes.
| |||||||||||
Modify priority of this filter.
| |||||||||||
Return an iterator over the filter's data types.
| |||||||||||
Flatten this object in to a Parcel.
| |||||||||||
Write the contents of the IntentFilter as an XML stream.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
android.os.Parcelable
|
The part of a match constant that applies a quality adjustment to the
basic category of match. The value MATCH_ADJUSTMENT_NORMAL
is no adjustment; higher numbers than that improve the quality, while
lower numbers reduce it.
Quality adjustment applied to the category of match that signifies the default, base value; higher numbers improve the quality while lower numbers reduce it.
The filter matched an intent that had no data specified.
The filter matched an intent with the same data URI scheme and authority host.
The part of a match constant that describes the category of match
that occurred. May be either MATCH_CATEGORY_EMPTY
,
MATCH_CATEGORY_SCHEME
, MATCH_CATEGORY_SCHEME_SPECIFIC_PART
,
MATCH_CATEGORY_HOST
, MATCH_CATEGORY_PORT
,
MATCH_CATEGORY_PATH
, or MATCH_CATEGORY_TYPE
. Higher
values indicate a better match.
The filter matched an intent with the same data URI scheme, authority, and path.
The filter matched an intent with the same data URI scheme and authority host and port.
The filter matched an intent with the same data URI scheme.
The filter matched an intent with the same data URI scheme and scheme specific part.
The filter matched an intent with the same data MIME type.
The filter didn't match due to different actions.
The filter didn't match because it required one or more categories that were not in the Intent.
The filter didn't match due to different data URIs.
The filter didn't match due to different MIME types.
The filter setPriority(int)
value at which system high-priority
receivers are placed; that is, receivers that should execute before
application code. Applications should never use filters with this or
higher priorities.
The filter setPriority(int)
value at which system low-priority
receivers are placed; that is, receivers that should execute after
application code. Applications should never use filters with this or
lower priorities.
New IntentFilter that matches a single action with no data. If no data characteristics are subsequently specified, then the filter will only match intents that contain no data.
action | The action to match, i.e. Intent.ACTION_MAIN. |
---|
New IntentFilter that matches a single action and data type.
Note: MIME type matching in the Android framework is case-sensitive, unlike formal RFC MIME types. As a result, you should always write your MIME types with lower case letters, and any MIME types you receive from outside of Android should be converted to lower case before supplying them here.
Throws IntentFilter.MalformedMimeTypeException
if the given MIME type is
not syntactically correct.
action | The action to match, i.e. Intent.ACTION_VIEW. |
---|---|
dataType | The type to match, i.e. "vnd.android.cursor.dir/person". |
New IntentFilter containing a copy of an existing filter.
o | The original filter to copy. |
---|
Return an iterator over the filter's actions. If there are no actions, returns null.
Add a new Intent action to match against. If any actions are included in the filter, then an Intent's action must be one of those values for it to match. If no actions are included, the Intent action is ignored.
action | Name of the action to match, i.e. Intent.ACTION_VIEW. |
---|
Add a new Intent category to match against. The semantics of categories is the opposite of actions -- an Intent includes the categories that it requires, all of which must be included in the filter in order to match. In other words, adding a category to the filter has no impact on matching unless that category is specified in the intent.
category | Name of category to match, i.e. Intent.CATEGORY_EMBED. |
---|
Add a new Intent data authority to match against. The filter must
include one or more schemes (via addDataScheme(String)
) for the
authority to be considered. If any authorities are
included in the filter, then an Intent's data must match one of
them. If no authorities are included, then only the scheme must match.
Note: host name in the Android framework is case-sensitive, unlike formal RFC host names. As a result, you should always write your host names with lower case letters, and any host names you receive from outside of Android should be converted to lower case before supplying them here.
host | The host part of the authority to match. May start with a single '*' to wildcard the front of the host name. |
---|---|
port | Optional port part of the authority to match. If null, any port is allowed. |
Add a new Intent data path to match against. The filter must
include one or more schemes (via addDataScheme(String)
) and
one or more authorities (via addDataAuthority(String, String)
) for the
path to be considered. If any paths are
included in the filter, then an Intent's data must match one of
them. If no paths are included, then only the scheme/authority must
match.
The path given here can either be a literal that must directly match or match against a prefix, or it can be a simple globbing pattern. If the latter, you can use '*' anywhere in the pattern to match zero or more instances of the previous character, '.' as a wildcard to match any character, and '\' to escape the next character.
path | Either a raw string that must exactly match the file path, or a simple pattern, depending on type. |
---|---|
type | Determines how path will be compared to
determine a match: either PATTERN_LITERAL ,
PATTERN_PREFIX , or
PATTERN_SIMPLE_GLOB . |
Add a new Intent data scheme to match against. If any schemes are included in the filter, then an Intent's data must be either one of these schemes or a matching data type. If no schemes are included, then an Intent will match only if it includes no data.
Note: scheme matching in the Android framework is case-sensitive, unlike formal RFC schemes. As a result, you should always write your schemes with lower case letters, and any schemes you receive from outside of Android should be converted to lower case before supplying them here.
scheme | Name of the scheme to match, i.e. "http". |
---|
Add a new Intent data "scheme specific part" to match against. The filter must
include one or more schemes (via addDataScheme(String)
) for the
scheme specific part to be considered. If any scheme specific parts are
included in the filter, then an Intent's data must match one of
them. If no scheme specific parts are included, then only the scheme must match.
The "scheme specific part" that this matches against is the string returned
by Uri.getSchemeSpecificPart
.
For Uris that contain a path, this kind of matching is not generally of interest,
since addDataAuthority(String, String)
and
addDataPath(String, int)
can provide a better mechanism for matching
them. However, for Uris that do not contain a path, the authority and path
are empty, so this is the only way to match against the non-scheme part.
ssp | Either a raw string that must exactly match the scheme specific part path, or a simple pattern, depending on type. |
---|---|
type | Determines how ssp will be compared to
determine a match: either PATTERN_LITERAL ,
PATTERN_PREFIX , or
PATTERN_SIMPLE_GLOB . |
Add a new Intent data type to match against. If any types are included in the filter, then an Intent's data must be either one of these types or a matching scheme. If no data types are included, then an Intent will only match if it specifies no data.
Note: MIME type matching in the Android framework is case-sensitive, unlike formal RFC MIME types. As a result, you should always write your MIME types with lower case letters, and any MIME types you receive from outside of Android should be converted to lower case before supplying them here.
Throws IntentFilter.MalformedMimeTypeException
if the given MIME type is
not syntactically correct.
type | Name of the data type to match, i.e. "vnd.android.cursor.dir/person". |
---|
Return an iterator over the filter's data authorities.
Return an iterator over the filter's categories.
null
if none.
Return the number of categories in the filter.
Return the number of data authorities in the filter.
Return the number of data paths in the filter.
Return the number of data scheme specific parts in the filter.
Return the number of data schemes in the filter.
Return the number of data types in the filter.
Create a new IntentFilter instance with a specified action and MIME
type, where you know the MIME type is correctly formatted. This catches
the IntentFilter.MalformedMimeTypeException
exception that the constructor
can call and turns it into a runtime exception.
action | The action to match, i.e. Intent.ACTION_VIEW. |
---|---|
dataType | The type to match, i.e. "vnd.android.cursor.dir/person". |
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
Return a data authority in the filter.
Return a data path in the filter.
Return a data scheme in the filter.
Return a data scheme specific part in the filter.
Is the given action included in the filter? Note that if the filter does not include any actions, false will always be returned.
action | The action to look for. |
---|
Is the given category included in the filter?
category | The category that the filter supports. |
---|
Is the given data authority included in the filter? Note that if the filter does not include any authorities, false will always be returned.
data | The data whose authority is being looked for. |
---|
Is the given data path included in the filter? Note that if the filter does not include any paths, false will always be returned.
data | The data path to look for. This is without the scheme prefix. |
---|
Is the given data scheme included in the filter? Note that if the filter does not include any scheme, false will always be returned.
scheme | The data scheme to look for. |
---|
Is the given data scheme specific part included in the filter? Note that if the filter does not include any scheme specific parts, false will always be returned.
data | The scheme specific part that is being looked for. |
---|
Is the given data type included in the filter? Note that if the filter does not include any type, false will always be returned.
type | The data type to look for. |
---|
Test whether this filter matches the given intent.
intent | The Intent to compare against. |
---|---|
resolve | If true, the intent's type will be resolved by calling Intent.resolveType(); otherwise a simple match against Intent.type will be performed. |
logTag | Tag to use in debugging messages. |
MATCH_CATEGORY_MASK
and MATCH_ADJUSTMENT_MASK
),
or one of the error codes NO_MATCH_TYPE
if the type didn't match,
NO_MATCH_DATA
if the scheme/path didn't match,
if the action didn't match, or
{@link #NO_MATCH_CATEGORY
if one or more categories didn't match.How well the filter matches. Negative if it doesn't match,
zero or positive positive value if it does with a higher
value representing a better match.Test whether this filter matches the given intent data. A match is
only successful if the actions and categories in the Intent match
against the filter, as described in IntentFilter
; in that case,
the match result returned will be as per matchData(String, String, Uri)
.
action | The intent action to match against (Intent.getAction). |
---|---|
type | The intent type to match against (Intent.resolveType()). |
scheme | The data scheme to match against (Intent.getScheme()). |
data | The data URI to match against (Intent.getData()). |
categories | The categories to match against (Intent.getCategories()). |
logTag | Tag to use in debugging messages. |
MATCH_CATEGORY_MASK
and MATCH_ADJUSTMENT_MASK
),
or one of the error codes NO_MATCH_TYPE
if the type didn't match,
NO_MATCH_DATA
if the scheme/path didn't match,
if the action didn't match, or
{@link #NO_MATCH_CATEGORY
if one or more categories didn't match.Match this filter against an Intent's action. If the filter does not specify any actions, the match will always fail.
action | The desired action to look for. |
---|
Match this filter against an Intent's categories. Each category in the Intent must be specified by the filter; if any are not in the filter, the match fails.
categories | The categories included in the intent, as returned by Intent.getCategories(). |
---|
Match this filter against an Intent's data (type, scheme and path). If the filter does not specify any types and does not specify any schemes/paths, the match will only succeed if the intent does not also specify a type or data. If the filter does not specify any schemes, it will implicitly match intents with no scheme, or the schemes "content:" or "file:" (basically performing a MIME-type only match). If the filter does not specify any MIME types, the Intent also must not specify a MIME type.
Be aware that to match against an authority, you must also specify a base scheme the authority is in. To match against a data path, both a scheme and authority must be specified. If the filter does not specify any types or schemes that it matches against, it is considered to be empty (any authority or data path given is ignored, as if it were empty as well).
Note: MIME type, Uri scheme, and host name matching in the Android framework is case-sensitive, unlike the formal RFC definitions. As a result, you should always write these elements with lower case letters, and normalize any MIME types or Uris you receive from outside of Android to ensure these elements are lower case before supplying them here.
type | The desired data type to look for, as returned by Intent.resolveType(). |
---|---|
scheme | The desired data scheme to look for, as returned by Intent.getScheme(). |
data | The full data string to match against, as supplied in Intent.data. |
MATCH_CATEGORY_MASK
and MATCH_ADJUSTMENT_MASK
),
or one of the error codes NO_MATCH_TYPE
if the type didn't match
or NO_MATCH_DATA
if the scheme/path didn't match.Match this intent filter against the given Intent data. This ignores
the data scheme -- unlike matchData(String, String, Uri)
, the authority will match
regardless of whether there is a matching scheme.
data | The data whose authority is being looked for. |
---|
MATCH_CATEGORY_HOST
,
MATCH_CATEGORY_PORT
, NO_MATCH_DATA
.
Return an iterator over the filter's data paths.
Return an iterator over the filter's data scheme specific parts.
Return an iterator over the filter's data schemes.
Modify priority of this filter. The default priority is 0. Positive
values will be before the default, lower values will be after it.
Applications must use a value that is larger than
SYSTEM_LOW_PRIORITY
and smaller than
SYSTEM_HIGH_PRIORITY
.
priority | The new priority value. |
---|
Return an iterator over the filter's data types.
Flatten this object in to a Parcel.
dest | The Parcel in which the object should be written. |
---|---|
flags | Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE .
|
Write the contents of the IntentFilter as an XML stream.
IOException |
---|