Added in API level 35

UriRelativeFilter


class UriRelativeFilter
kotlin.Any
   ↳ android.content.UriRelativeFilter

A filter for matching Intent URI Data as part of a UriRelativeFilterGroup. A single filter can only be matched against either a URI path, query or fragment

Summary

Constants
static Int

Value to indicate that the filter is to be applied to a URI fragment.

static Int

Value to indicate that the filter is to be applied to a URI path.

static Int

Value to indicate that the filter is to be applied to a URI query.

Public constructors
UriRelativeFilter(uriPart: Int, patternType: Int, filter: String)

Creates a new UriRelativeFilter.

Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

String

The string used to filter the URI.

Int

The pattern type of the filter.

Int

The URI part this filter operates on.

Int

Returns a hash code value for the object.

Boolean
matchData(data: Uri)

Match this URI filter against an Intent's data.

String

Returns a string representation of the object.

Constants

FRAGMENT

Added in API level 35
static val FRAGMENT: Int

Value to indicate that the filter is to be applied to a URI fragment.

Value: 2

PATH

Added in API level 35
static val PATH: Int

Value to indicate that the filter is to be applied to a URI path.

Value: 0

QUERY

Added in API level 35
static val QUERY: Int

Value to indicate that the filter is to be applied to a URI query.

Value: 1

Public constructors

UriRelativeFilter

Added in API level 35
UriRelativeFilter(
    uriPart: Int,
    patternType: Int,
    filter: String)

Creates a new UriRelativeFilter.

Parameters
uriPart Int: The URI part this filter operates on. Can be either a UriRelativeFilter.PATH, UriRelativeFilter.QUERY, or UriRelativeFilter.FRAGMENT.
Value is one of the following:
patternType Int: The pattern type of the filter. Can be either a PatternMatcher.PATTERN_LITERAL, PatternMatcher.PATTERN_PREFIX, PatternMatcher.PATTERN_SUFFIX, PatternMatcher.PATTERN_SIMPLE_GLOB, or PatternMatcher.PATTERN_ADVANCED_GLOB.
Value is one of the following:
filter String: A literal or pattern string depedning on patterType used to match a uriPart .
This value cannot be null.

Public methods

equals

Added in API level 35
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getFilter

Added in API level 35
fun getFilter(): String

The string used to filter the URI.

Return
String This value cannot be null.

getUriPart

Added in API level 35
fun getUriPart(): Int

The URI part this filter operates on.

Return
Int Value is one of the following:

hashCode

Added in API level 35
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

matchData

Added in API level 35
fun matchData(data: Uri): Boolean

Match this URI filter against an Intent's data. QUERY filters can match against any key value pair in the query string. PATH and FRAGMENT filters must match the entire string.

Parameters
data Uri: The full data string to match against, as supplied in Intent.data.
This value cannot be null.
Return
Boolean true if there is a match.

toString

Added in API level 35
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.