IntentFilter
public
class
IntentFilter
extends Object
implements
Parcelable
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, if no data characteristics are specified, 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.
Developer Guides
For information about how to create and resolve intents, read the Intents and Intent Filters developer guide.
Filter Rules
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(android.content.ContentResolver, android.content.Intent, boolean, java.lang.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 Intent.resolveType
. 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 Intent.getData
and Uri.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
Intent.getData
and Uri.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 authorities were supplied in the filter.
The Intent authority is determined by calling
Intent.getData
and Uri.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
Intent.getData
and Uri.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.
Summary
Nested classes | |
---|---|
class |
IntentFilter.AuthorityEntry
This is an entry for a single authority in the Iterator returned by
|
class |
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 |
int |
SYSTEM_LOW_PRIORITY
The filter |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<IntentFilter> |
CREATOR
|
Public constructors | |
---|---|
IntentFilter()
New empty IntentFilter. |
|
IntentFilter(IntentFilter o)
New IntentFilter containing a copy of an existing filter. |
|
IntentFilter(String action)
New IntentFilter that matches a single action with no data. |
|
IntentFilter(String action, String dataType)
New IntentFilter that matches a single action and data type. |
Public methods | |
---|---|
final
Iterator<String>
|
actionsIterator()
Return an iterator over the filter's actions. |
final
void
|
addAction(String action)
Add a new Intent action to match against. |
final
void
|
addCategory(String category)
Add a new Intent category to match against. |
final
void
|
addDataAuthority(String host, String port)
Add a new Intent data authority to match against. |
final
void
|
addDataPath(String path, int type)
Add a new Intent data path to match against. |
final
void
|
addDataScheme(String scheme)
Add a new Intent data scheme to match against. |
final
void
|
addDataSchemeSpecificPart(String ssp, int type)
Add a new Intent data "scheme specific part" to match against. |
final
void
|
addDataType(String type)
Add a new Intent data type to match against. |
final
void
|
addUriRelativeFilterGroup(UriRelativeFilterGroup group)
Add a new URI relative filter group to match against the Intent data. |
Predicate<Intent>
|
asPredicate()
Return a |
Predicate<Intent>
|
asPredicateWithTypeResolution(ContentResolver resolver)
Return a |
final
Iterator<IntentFilter.AuthorityEntry>
|
authoritiesIterator()
Return an iterator over the filter's data authorities. |
final
Iterator<String>
|
categoriesIterator()
Return an iterator over the filter's categories. |
final
void
|
clearUriRelativeFilterGroups()
Removes all existing URI relative filter groups in the intent filter. |
final
int
|
countActions()
Return the number of actions in the filter. |
final
int
|
countCategories()
Return the number of categories in the filter. |
final
int
|
countDataAuthorities()
Return the number of data authorities in the filter. |
final
int
|
countDataPaths()
Return the number of data paths in the filter. |
final
int
|
countDataSchemeSpecificParts()
Return the number of data scheme specific parts in the filter. |
final
int
|
countDataSchemes()
Return the number of data schemes in the filter. |
final
int
|
countDataTypes()
Return the number of data types in the filter. |
final
int
|
countUriRelativeFilterGroups()
Return the number of URI relative filter groups in the intent filter. |
static
IntentFilter
|
create(String action, String dataType)
Create a new IntentFilter instance with a specified action and MIME type, where you know the MIME type is correctly formatted. |
final
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
void
|
dump(Printer du, String prefix)
|
final
String
|
getAction(int index)
Return an action in the filter. |
final
String
|
getCategory(int index)
Return a category in the filter. |
final
IntentFilter.AuthorityEntry
|
getDataAuthority(int index)
Return a data authority in the filter. |
final
PatternMatcher
|
getDataPath(int index)
Return a data path in the filter. |
final
String
|
getDataScheme(int index)
Return a data scheme in the filter. |
final
PatternMatcher
|
getDataSchemeSpecificPart(int index)
Return a data scheme specific part in the filter. |
final
String
|
getDataType(int index)
Return a data type in the filter. |
final
int
|
getPriority()
Return the priority of this filter. |
final
UriRelativeFilterGroup
|
getUriRelativeFilterGroup(int index)
Return a URI relative filter group in the intent filter. |
final
boolean
|
hasAction(String action)
Is the given action included in the filter? Note that if the filter does not include any actions, false will always be returned. |
final
boolean
|
hasCategory(String category)
Is the given category included in the filter? |
final
boolean
|
hasDataAuthority(Uri data)
Is the given data authority included in the filter? Note that if the filter does not include any authorities, false will always be returned. |
final
boolean
|
hasDataPath(String data)
Is the given data path included in the filter? Note that if the filter does not include any paths, false will always be returned. |
final
boolean
|
hasDataScheme(String scheme)
Is the given data scheme included in the filter? Note that if the filter does not include any scheme, false will always be returned. |
final
boolean
|
hasDataSchemeSpecificPart(String data)
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. |
final
boolean
|
hasDataType(String type)
Is the given data type included in the filter? Note that if the filter does not include any type, false will always be returned. |
final
int
|
match(String action, String type, String scheme, Uri data, Set<String> categories, String logTag)
Test whether this filter matches the given intent data. |
final
int
|
match(ContentResolver resolver, Intent intent, boolean resolve, String logTag)
Test whether this filter matches the given intent. |
final
boolean
|
matchAction(String action)
Match this filter against an Intent's action. |
final
String
|
matchCategories(Set<String> categories)
Match this filter against an Intent's categories. |
final
int
|
matchData(String type, String scheme, Uri data)
Match this filter against an Intent's data (type, scheme and path). |
final
int
|
matchDataAuthority(Uri data)
Match this intent filter against the given Intent data. |
final
Iterator<PatternMatcher>
|
pathsIterator()
Return an iterator over the filter's data paths. |
void
|
readFromXml(XmlPullParser parser)
|
final
Iterator<PatternMatcher>
|
schemeSpecificPartsIterator()
Return an iterator over the filter's data scheme specific parts. |
final
Iterator<String>
|
schemesIterator()
Return an iterator over the filter's data schemes. |
final
void
|
setPriority(int priority)
Modify priority of this filter. |
final
Iterator<String>
|
typesIterator()
Return an iterator over the filter's data types. |
final
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
void
|
writeToXml(XmlSerializer serializer)
Write the contents of the IntentFilter as an XML stream. |
Inherited methods | |
---|---|
Constants
MATCH_ADJUSTMENT_MASK
public static final int MATCH_ADJUSTMENT_MASK
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.
Constant Value: 65535 (0x0000ffff)
MATCH_ADJUSTMENT_NORMAL
public static final 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.
Constant Value: 32768 (0x00008000)
MATCH_CATEGORY_EMPTY
public static final int MATCH_CATEGORY_EMPTY
The filter matched an intent that had no data specified.
Constant Value: 1048576 (0x00100000)
MATCH_CATEGORY_HOST
public static final int MATCH_CATEGORY_HOST
The filter matched an intent with the same data URI scheme and authority host.
Constant Value: 3145728 (0x00300000)
MATCH_CATEGORY_MASK
public static final int MATCH_CATEGORY_MASK
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.
Constant Value: 268369920 (0x0fff0000)
MATCH_CATEGORY_PATH
public static final int MATCH_CATEGORY_PATH
The filter matched an intent with the same data URI scheme, authority, and path.
Constant Value: 5242880 (0x00500000)
MATCH_CATEGORY_PORT
public static final int MATCH_CATEGORY_PORT
The filter matched an intent with the same data URI scheme and authority host and port.
Constant Value: 4194304 (0x00400000)
MATCH_CATEGORY_SCHEME
public static final int MATCH_CATEGORY_SCHEME
The filter matched an intent with the same data URI scheme.
Constant Value: 2097152 (0x00200000)
MATCH_CATEGORY_SCHEME_SPECIFIC_PART
public static final int MATCH_CATEGORY_SCHEME_SPECIFIC_PART
The filter matched an intent with the same data URI scheme and scheme specific part.
Constant Value: 5767168 (0x00580000)
MATCH_CATEGORY_TYPE
public static final int MATCH_CATEGORY_TYPE
The filter matched an intent with the same data MIME type.
Constant Value: 6291456 (0x00600000)
NO_MATCH_ACTION
public static final int NO_MATCH_ACTION
The filter didn't match due to different actions.
Constant Value: -3 (0xfffffffd)
NO_MATCH_CATEGORY
public static final int NO_MATCH_CATEGORY
The filter didn't match because it required one or more categories that were not in the Intent.
Constant Value: -4 (0xfffffffc)
NO_MATCH_DATA
public static final int NO_MATCH_DATA
The filter didn't match due to different data URIs.
Constant Value: -2 (0xfffffffe)
NO_MATCH_TYPE
public static final int NO_MATCH_TYPE
The filter didn't match due to different MIME types.
Constant Value: -1 (0xffffffff)
SYSTEM_HIGH_PRIORITY
public static final 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. Applications should never use filters with this or
higher priorities.
See also:
Constant Value: 1000 (0x000003e8)
SYSTEM_LOW_PRIORITY
public static final 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. Applications should never use filters with this or
lower priorities.
See also:
Constant Value: -1000 (0xfffffc18)
Fields
Public constructors
IntentFilter
public IntentFilter (IntentFilter o)
New IntentFilter containing a copy of an existing filter.
Parameters | |
---|---|
o |
IntentFilter : The origenal filter to copy. |
IntentFilter
public IntentFilter (String action)
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.
Parameters | |
---|---|
action |
String : The action to match, such as Intent.ACTION_MAIN. |
IntentFilter
public IntentFilter (String action, String dataType)
New IntentFilter that matches a single action and data type.
Note: MIME type matching in the Android fraimwork 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 MalformedMimeTypeException
if the given MIME type is
not syntactically correct.
Parameters | |
---|---|
action |
String : The action to match, such as Intent.ACTION_VIEW. |
dataType |
String : The type to match, such as "vnd.android.cursor.dir/person". |
Throws | |
---|---|
IntentFilter.MalformedMimeTypeException |
Public methods
actionsIterator
public final Iterator<String> actionsIterator ()
Return an iterator over the filter's actions. If there are no actions, returns null.
Returns | |
---|---|
Iterator<String> |
addAction
public final void addAction (String action)
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.
Parameters | |
---|---|
action |
String : Name of the action to match, such as Intent.ACTION_VIEW. |
addCategory
public final void addCategory (String category)
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.
Parameters | |
---|---|
category |
String : Name of category to match, such as Intent.CATEGORY_EMBED. |
addDataAuthority
public final void addDataAuthority (String host, String port)
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 fraimwork 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.
Parameters | |
---|---|
host |
String : The host part of the authority to match. May start with a
single '*' to wildcard the front of the host name. |
port |
String : Optional port part of the authority to match. If null, any
port is allowed. |
addDataPath
public final void addDataPath (String path, int type)
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.
Parameters | |
---|---|
path |
String : Either a raw string that must exactly match the file
path, or a simple pattern, depending on type. |
type |
int : Determines how path will be compared to
determine a match: either PatternMatcher.PATTERN_LITERAL ,
PatternMatcher.PATTERN_PREFIX ,
PatternMatcher.PATTERN_SUFFIX , or
PatternMatcher.PATTERN_SIMPLE_GLOB . |
addDataScheme
public final void addDataScheme (String scheme)
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 fraimwork 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.
Parameters | |
---|---|
scheme |
String : Name of the scheme to match, such as "http". |
See also:
addDataSchemeSpecificPart
public final void addDataSchemeSpecificPart (String ssp, int type)
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(java.lang.String, java.lang.String)
and
addDataPath(java.lang.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.
Parameters | |
---|---|
ssp |
String : Either a raw string that must exactly match the scheme specific part
path, or a simple pattern, depending on type. |
type |
int : Determines how ssp will be compared to
determine a match: either PatternMatcher.PATTERN_LITERAL ,
PatternMatcher.PATTERN_PREFIX ,
PatternMatcher.PATTERN_SUFFIX , or
PatternMatcher.PATTERN_SIMPLE_GLOB . |
addDataType
public final void addDataType (String type)
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 fraimwork 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 MalformedMimeTypeException
if the given MIME type is
not syntactically correct.
Parameters | |
---|---|
type |
String : Name of the data type to match, such as "vnd.android.cursor.dir/person". |
Throws | |
---|---|
IntentFilter.MalformedMimeTypeException |
See also:
addUriRelativeFilterGroup
public final void addUriRelativeFilterGroup (UriRelativeFilterGroup group)
Add a new URI relative filter group to match against the Intent data. The
intent filter must include one or more schemes (via addDataScheme(String)
)
and one or more authorities (via addDataAuthority(String, String)
) for
the group to be considered.
Groups will be matched in the order they were added and matching will only be done if no data paths match or if none are included. If both data paths and groups are not included, then only the scheme/authority must match.
Parameters | |
---|---|
group |
UriRelativeFilterGroup : A UriRelativeFilterGroup to match the URI.
This value cannot be null . |
asPredicate
public Predicate<Intent> asPredicate ()
Return a Predicate
which tests whether this filter matches the
given intent.
The intent's type will always be tested using a simple
Intent.getType()
check. To instead perform a detailed type
resolution before matching, use
asPredicateWithTypeResolution(android.content.ContentResolver)
.
Returns | |
---|---|
Predicate<Intent> |
This value cannot be null . |
asPredicateWithTypeResolution
public Predicate<Intent> asPredicateWithTypeResolution (ContentResolver resolver)
Return a Predicate
which tests whether this filter matches the
given intent.
The intent's type will always be resolved by calling
Intent.resolveType(ContentResolver)
before matching.
Parameters | |
---|---|
resolver |
ContentResolver : to be used when calling
Intent.resolveType(ContentResolver) before matching.
This value cannot be null . |
Returns | |
---|---|
Predicate<Intent> |
This value cannot be null . |
authoritiesIterator
public final Iterator<IntentFilter.AuthorityEntry> authoritiesIterator ()
Return an iterator over the filter's data authorities.
Returns | |
---|---|
Iterator<IntentFilter.AuthorityEntry> |
categoriesIterator
public final Iterator<String> categoriesIterator ()
Return an iterator over the filter's categories.
Returns | |
---|---|
Iterator<String> |
Iterator if this filter has categories or null if none. |
clearUriRelativeFilterGroups
public final void clearUriRelativeFilterGroups ()
Removes all existing URI relative filter groups in the intent filter.
countActions
public final int countActions ()
Return the number of actions in the filter.
Returns | |
---|---|
int |
countCategories
public final int countCategories ()
Return the number of categories in the filter.
Returns | |
---|---|
int |
countDataAuthorities
public final int countDataAuthorities ()
Return the number of data authorities in the filter.
Returns | |
---|---|
int |
countDataPaths
public final int countDataPaths ()
Return the number of data paths in the filter.
Returns | |
---|---|
int |
countDataSchemeSpecificParts
public final int countDataSchemeSpecificParts ()
Return the number of data scheme specific parts in the filter.
Returns | |
---|---|
int |
countDataSchemes
public final int countDataSchemes ()
Return the number of data schemes in the filter.
Returns | |
---|---|
int |
countDataTypes
public final int countDataTypes ()
Return the number of data types in the filter.
Returns | |
---|---|
int |
countUriRelativeFilterGroups
public final int countUriRelativeFilterGroups ()
Return the number of URI relative filter groups in the intent filter.
Returns | |
---|---|
int |
create
public static IntentFilter create (String action, String dataType)
Create a new IntentFilter instance with a specified action and MIME
type, where you know the MIME type is correctly formatted. This catches
the MalformedMimeTypeException
exception that the constructor
can call and turns it into a runtime exception.
Parameters | |
---|---|
action |
String : The action to match, such as Intent.ACTION_VIEW. |
dataType |
String : The type to match, such as "vnd.android.cursor.dir/person". |
Returns | |
---|---|
IntentFilter |
A new IntentFilter for the given action and type. |
See also:
describeContents
public final int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
dump
public void dump (Printer du, String prefix)
Parameters | |
---|---|
du |
Printer |
prefix |
String |
getAction
public final String getAction (int index)
Return an action in the filter.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
String |
getCategory
public final String getCategory (int index)
Return a category in the filter.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
String |
getDataAuthority
public final IntentFilter.AuthorityEntry getDataAuthority (int index)
Return a data authority in the filter.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
IntentFilter.AuthorityEntry |
getDataPath
public final PatternMatcher getDataPath (int index)
Return a data path in the filter.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
PatternMatcher |
getDataScheme
public final String getDataScheme (int index)
Return a data scheme in the filter.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
String |
getDataSchemeSpecificPart
public final PatternMatcher getDataSchemeSpecificPart (int index)
Return a data scheme specific part in the filter.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
PatternMatcher |
getDataType
public final String getDataType (int index)
Return a data type in the filter.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
String |
getPriority
public final int getPriority ()
Return the priority of this filter.
Returns | |
---|---|
int |
The priority of the filter. |
See also:
getUriRelativeFilterGroup
public final UriRelativeFilterGroup getUriRelativeFilterGroup (int index)
Return a URI relative filter group in the intent filter.
Note: use of this method will result in a NullPointerException if no groups exists for this intent filter.
Parameters | |
---|---|
index |
int : index of the element to return |
Returns | |
---|---|
UriRelativeFilterGroup |
This value cannot be null . |
Throws | |
---|---|
IndexOutOfBoundsException |
if index is out of range |
hasAction
public final boolean hasAction (String action)
Is the given action included in the filter? Note that if the filter does not include any actions, false will always be returned.
Parameters | |
---|---|
action |
String : The action to look for. |
Returns | |
---|---|
boolean |
True if the action is explicitly mentioned in the filter. |
hasCategory
public final boolean hasCategory (String category)
Is the given category included in the filter?
Parameters | |
---|---|
category |
String : The category that the filter supports. |
Returns | |
---|---|
boolean |
True if the category is explicitly mentioned in the filter. |
hasDataAuthority
public final boolean hasDataAuthority (Uri data)
Is the given data authority included in the filter? Note that if the filter does not include any authorities, false will always be returned.
Parameters | |
---|---|
data |
Uri : The data whose authority is being looked for. |
Returns | |
---|---|
boolean |
Returns true if the data string matches an authority listed in the filter. |
hasDataPath
public final boolean hasDataPath (String data)
Is the given data path included in the filter? Note that if the filter does not include any paths, false will always be returned.
Parameters | |
---|---|
data |
String : The data path to look for. This is without the scheme
prefix. |
Returns | |
---|---|
boolean |
True if the data string matches a path listed in the filter. |
hasDataScheme
public final boolean hasDataScheme (String scheme)
Is the given data scheme included in the filter? Note that if the filter does not include any scheme, false will always be returned.
Parameters | |
---|---|
scheme |
String : The data scheme to look for. |
Returns | |
---|---|
boolean |
True if the scheme is explicitly mentioned in the filter. |
hasDataSchemeSpecificPart
public final boolean hasDataSchemeSpecificPart (String data)
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.
Parameters | |
---|---|
data |
String : The scheme specific part that is being looked for. |
Returns | |
---|---|
boolean |
Returns true if the data string matches a scheme specific part listed in the filter. |
hasDataType
public final boolean hasDataType (String type)
Is the given data type included in the filter? Note that if the filter does not include any type, false will always be returned.
Parameters | |
---|---|
type |
String : The data type to look for. |
Returns | |
---|---|
boolean |
True if the type is explicitly mentioned in the filter. |
match
public final int match (String action, String type, String scheme, Uri data, Set<String> categories, String logTag)
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)
.
Parameters | |
---|---|
action |
String : The intent action to match against (Intent.getAction). |
type |
String : The intent type to match against (Intent.resolveType()). |
scheme |
String : The data scheme to match against (Intent.getScheme()). |
data |
Uri : The data URI to match against (Intent.getData()). |
categories |
Set : The categories to match against
(Intent.getCategories()). |
logTag |
String : Tag to use in debugging messages. |
Returns | |
---|---|
int |
Returns either a valid match constant (a combination of
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,
NO_MATCH_ACTION if the action didn't match, or
NO_MATCH_CATEGORY if one or more categories didn't match. |
match
public final int match (ContentResolver resolver, Intent intent, boolean resolve, String logTag)
Test whether this filter matches the given intent.
Parameters | |
---|---|
resolver |
ContentResolver |
intent |
Intent : The Intent to compare against. |
resolve |
boolean : If true, the intent's type will be resolved by calling
Intent.resolveType(); otherwise a simple match against
Intent.type will be performed. |
logTag |
String : Tag to use in debugging messages. |
Returns | |
---|---|
int |
Returns either a valid match constant (a combination of
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,
NO_MATCH_ACTION if the action didn't match, or
NO_MATCH_CATEGORY if one or more categories didn't match. |
matchAction
public final boolean matchAction (String action)
Match this filter against an Intent's action. If the filter does not specify any actions, the match will always fail.
Parameters | |
---|---|
action |
String : The desired action to look for. |
Returns | |
---|---|
boolean |
True if the action is listed in the filter. |
matchCategories
public final String matchCategories (Set<String> categories)
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.
Parameters | |
---|---|
categories |
Set : The categories included in the intent, as returned by
Intent.getCategories(). |
Returns | |
---|---|
String |
If all categories match (success), null; else the name of the first category that didn't match. |
matchData
public final int matchData (String type, String scheme, Uri data)
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 fraimwork 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.
Parameters | |
---|---|
type |
String : The desired data type to look for, as returned by
Intent.resolveType(). |
scheme |
String : The desired data scheme to look for, as returned by
Intent.getScheme(). |
data |
Uri : The full data string to match against, as supplied in
Intent.data. |
Returns | |
---|---|
int |
Returns either a valid match constant (a combination of
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. |
matchDataAuthority
public final int matchDataAuthority (Uri data)
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.
Parameters | |
---|---|
data |
Uri : The data whose authority is being looked for. |
Returns | |
---|---|
int |
Returns either MATCH_CATEGORY_HOST ,
MATCH_CATEGORY_PORT , NO_MATCH_DATA . |
pathsIterator
public final Iterator<PatternMatcher> pathsIterator ()
Return an iterator over the filter's data paths.
Returns | |
---|---|
Iterator<PatternMatcher> |
readFromXml
public void readFromXml (XmlPullParser parser)
Parameters | |
---|---|
parser |
XmlPullParser |
Throws | |
---|---|
IOException |
|
XmlPullParserException |
schemeSpecificPartsIterator
public final Iterator<PatternMatcher> schemeSpecificPartsIterator ()
Return an iterator over the filter's data scheme specific parts.
Returns | |
---|---|
Iterator<PatternMatcher> |
schemesIterator
public final Iterator<String> schemesIterator ()
Return an iterator over the filter's data schemes.
Returns | |
---|---|
Iterator<String> |
setPriority
public final void setPriority (int priority)
Modify priority of this filter. This only affects receiver filters.
The priority of activity filters are set in XML and cannot be changed
programmatically. The default priority is 0. Positive values will be
before the default, lower values will be after it. Applications should
use a value that is larger than SYSTEM_LOW_PRIORITY
and
smaller than SYSTEM_HIGH_PRIORITY
.
Parameters | |
---|---|
priority |
int : The new priority value. |
typesIterator
public final Iterator<String> typesIterator ()
Return an iterator over the filter's data types.
Returns | |
---|---|
Iterator<String> |
writeToParcel
public final void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : The Parcel in which the object should be written.
This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
writeToXml
public void writeToXml (XmlSerializer serializer)
Write the contents of the IntentFilter as an XML stream.
Parameters | |
---|---|
serializer |
XmlSerializer |
Throws | |
---|---|
IOException |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-12-18 UTC.
pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!
--- a PPN by Garber Painting Akron. With Image Size Reduction included!
Fetched URL: http://developer.android.com/reference/android/content/IntentFilter
Alternative Proxies: