IT. Expert System.

Android Reference

IntentFilter


android.content

Class IntentFilter

  • All Implemented Interfaces:
    Parcelable
    Direct Known Subclasses:
    PackageParser.IntentInfo


    public class IntentFilter
    extends Object
    implements Parcelable
    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(java.lang.String), addDataType(java.lang.String), addDataScheme(java.lang.String) addDataAuthority(java.lang.String, java.lang.String), addDataPath(java.lang.String, int), and addCategory(java.lang.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.

    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.

    Action matches if any of the given values match the Intent action, or if no actions were specified in the filter.

    Data Type matches if any of the given values match the Intent type. The Intent type is determined by calling Intent.resolveType(android.content.Context). 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 Authority matches if any of the given values match the Intent's data authority and one of the data scheme's in the filter has matched the Intent, or no authories 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.

    • Field Detail

      • 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:
        setPriority(int), Constant Field Values
      • 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:
        setPriority(int), Constant Field Values
      • 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.
        See Also:
        Constant Field Values
      • 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.
        See Also:
        Constant Field Values
      • MATCH_CATEGORY_EMPTY

        public static final int MATCH_CATEGORY_EMPTY
        The filter matched an intent that had no data specified.
        See Also:
        Constant Field Values
      • MATCH_CATEGORY_SCHEME

        public static final int MATCH_CATEGORY_SCHEME
        The filter matched an intent with the same data URI scheme.
        See Also:
        Constant Field Values
      • MATCH_CATEGORY_HOST

        public static final int MATCH_CATEGORY_HOST
        The filter matched an intent with the same data URI scheme and authority host.
        See Also:
        Constant Field Values
      • 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.
        See Also:
        Constant Field Values
      • MATCH_CATEGORY_PATH

        public static final int MATCH_CATEGORY_PATH
        The filter matched an intent with the same data URI scheme, authority, and path.
        See Also:
        Constant Field Values
      • MATCH_CATEGORY_TYPE

        public static final int MATCH_CATEGORY_TYPE
        The filter matched an intent with the same data MIME type.
        See Also:
        Constant Field Values
      • NO_MATCH_TYPE

        public static final int NO_MATCH_TYPE
        The filter didn't match due to different MIME types.
        See Also:
        Constant Field Values
      • NO_MATCH_DATA

        public static final int NO_MATCH_DATA
        The filter didn't match due to different data URIs.
        See Also:
        Constant Field Values
      • NO_MATCH_ACTION

        public static final int NO_MATCH_ACTION
        The filter didn't match due to different actions.
        See Also:
        Constant Field Values
      • 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.
        See Also:
        Constant Field Values
    • Constructor Detail

      • IntentFilter

        public IntentFilter()
        New empty IntentFilter.
      • 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 - The action to match, i.e. Intent.ACTION_MAIN.
      • IntentFilter

        public IntentFilter(String action,
                    String dataType)
                     throws IntentFilter.MalformedMimeTypeException
        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.

        Parameters:
        action - The action to match, i.e. Intent.ACTION_VIEW.
        dataType - The type to match, i.e. "vnd.android.cursor.dir/person".
        Throws:
        IntentFilter.MalformedMimeTypeException
      • IntentFilter

        public IntentFilter(IntentFilter o)
        New IntentFilter containing a copy of an existing filter.
        Parameters:
        o - The original filter to copy.
    • Method Detail

      • 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 IntentFilter.MalformedMimeTypeException exception that the constructor can call and turns it into a runtime exception.
        Parameters:
        action - The action to match, i.e. Intent.ACTION_VIEW.
        dataType - The type to match, i.e. "vnd.android.cursor.dir/person".
        Returns:
        A new IntentFilter for the given action and type.
        See Also:
        IntentFilter(String, String)
      • getPriority

        public final int getPriority()
        Return the priority of this filter.
        Returns:
        The priority of the filter.
        See Also:
        setPriority(int)
      • 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 - Name of the action to match, i.e. Intent.ACTION_VIEW.
      • countActions

        public final int countActions()
        Return the number of actions in the filter.
      • getAction

        public final String getAction(int index)
        Return an action in the filter.
      • 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 - The action to look for.
        Returns:
        True if the action is explicitly mentioned in the filter.
      • 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 - The desired action to look for.
        Returns:
        True if the action is listed in the filter.
      • actionsIterator

        public final Iterator<String> actionsIterator()
        Return an iterator over the filter's actions. If there are no actions, returns null.
      • addDataType

        public final void addDataType(String type)
                               throws IntentFilter.MalformedMimeTypeException
        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.

        Parameters:
        type - Name of the data type to match, i.e. "vnd.android.cursor.dir/person".
        Throws:
        IntentFilter.MalformedMimeTypeException
        See Also:
        matchData(java.lang.String, java.lang.String, android.net.Uri)
      • 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 - The data type to look for.
        Returns:
        True if the type is explicitly mentioned in the filter.
      • countDataTypes

        public final int countDataTypes()
        Return the number of data types in the filter.
      • getDataType

        public final String getDataType(int index)
        Return a data type in the filter.
      • typesIterator

        public final Iterator<String> typesIterator()
        Return an iterator over the filter's data types.
      • 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 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.

        Parameters:
        scheme - Name of the scheme to match, i.e. "http".
        See Also:
        matchData(java.lang.String, java.lang.String, android.net.Uri)
      • countDataSchemes

        public final int countDataSchemes()
        Return the number of data schemes in the filter.
      • getDataScheme

        public final String getDataScheme(int index)
        Return a data scheme 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 - The data scheme to look for.
        Returns:
        True if the scheme is explicitly mentioned in the filter.
      • schemesIterator

        public final Iterator<String> schemesIterator()
        Return an iterator over the filter's data schemes.
      • 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(java.lang.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.

        Parameters:
        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.
        See Also:
        matchData(java.lang.String, java.lang.String, android.net.Uri), addDataScheme(java.lang.String)
      • countDataAuthorities

        public final int countDataAuthorities()
        Return the number of data authorities 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 - The data whose authority is being looked for.
        Returns:
        Returns true if the data string matches an authority listed in the filter.
      • countDataPaths

        public final int countDataPaths()
        Return the number of data paths in the filter.
      • getDataPath

        public final PatternMatcher getDataPath(int index)
        Return a data path 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 - The data path to look for. This is without the scheme prefix.
        Returns:
        True if the data string matches a path listed in the filter.
      • pathsIterator

        public final Iterator<PatternMatcher> pathsIterator()
        Return an iterator over the filter's data paths.
      • 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.

        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.

        Parameters:
        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.
        Returns:
        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.
        See Also:
        match(android.content.ContentResolver, android.content.Intent, boolean, java.lang.String)
      • 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 - Name of category to match, i.e. Intent.CATEGORY_EMBED.
      • countCategories

        public final int countCategories()
        Return the number of categories in the filter.
      • getCategory

        public final String getCategory(int index)
        Return a category in the filter.
      • hasCategory

        public final boolean hasCategory(String category)
        Is the given category included in the filter?
        Parameters:
        category - The category that the filter supports.
        Returns:
        True if the category is explicitly mentioned in the filter.
      • categoriesIterator

        public final Iterator<String> categoriesIterator()
        Return an iterator over the filter's categories.
        Returns:
        Iterator if this filter has categories or null if none.
      • 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 - The categories included in the intent, as returned by Intent.getCategories().
        Returns:
        If all categories match (success), null; else the name of the first category that 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:
        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.
        Returns:
        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 {@link #NO_MATCH_CATEGORY} if one or more categories didn't match.
        See Also:
        match(String, String, String, android.net.Uri , Set, String)
      • describeContents

        public final int describeContents()
        Description copied from interface: Parcelable
        Describe the kinds of special objects contained in this Parcelable's marshalled representation.
        Specified by:
        describeContents in interface Parcelable
        Returns:
        a bitmask indicating the set of special object types marshalled by the Parcelable.
      • debugCheck

        public boolean debugCheck()
        For debugging -- perform a check on the filter, return true if it passed or false if it failed.


Content

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.
All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.
Copyright 2016 © ELTASK.COM. All rights reserved.
Site is optimized for mobile devices.
Downloads: 1744 / 96487543. Delta: 0.05404 с