Added in API level 35

UriRelativeFilterGroup

class UriRelativeFilterGroup
kotlin.Any
   ↳ android.content.UriRelativeFilterGroup

An intent data matching group based on a URI's relative reference which includes the path, query and fragment. The group is only considered as matching if all UriRelativeFilters in the group match. Each UriRelativeFilter defines a matching rule for a URI path, query or fragment. A group must contain one or more UriRelativeFilters to match but does not need to contain UriRelativeFilters for all existing parts of a URI to match.

For example, given a URI that contains path, query and fragment parts, a group containing only a path filter will match the URI if the path filter matches the URI path. If the group contains a path and query filter, then the group will only match if both path and query filters match. If a URI contains only a path with no query or fragment then a group can only match if it contains only a matching path filter. If the group also contained additional query or fragment filters then it will not match.

Summary

Constants
static Int

Value to indicate that the group match is allowed.
static Int

Value to indicate that the group match is blocked.
Public constructors

New UriRelativeFilterGroup that matches a Intent data.
Public methods
Unit

Add a filter to the group.
Boolean
equals(other: Any?)

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

Return UriRelativeFilterGroup.ACTION_ALLOW if a URI is allowed when matched and UriRelativeFilterGroup.ACTION_BLOCK if a URI is blacked when matched.
MutableCollection<UriRelativeFilter!>

Returns a unmodifiable view of the UriRelativeFilters list in this group.
Int

Boolean
matchData(data: Uri)

Match all URI filter in this group against Intent.getData().
String

Constants

ACTION_ALLOW

Added in API level 35
static val ACTION_ALLOW: Int

Value to indicate that the group match is allowed.

Value: 0

ACTION_BLOCK

Added in API level 35
static val ACTION_BLOCK: Int

Value to indicate that the group match is blocked.

Value: 1

Public constructors

UriRelativeFilterGroup

Added in API level 35
UriRelativeFilterGroup(action: Int)

New UriRelativeFilterGroup that matches a Intent data.

Parameters
action Int: Whether this matching group should be allowed or disallowed. Value is android.content.UriRelativeFilterGroup#ACTION_ALLOW, or android.content.UriRelativeFilterGroup#ACTION_BLOCK

Public methods

addUriRelativeFilter

Added in API level 35
fun addUriRelativeFilter(uriRelativeFilter: UriRelativeFilter): Unit

Add a filter to the group.

Parameters
uriRelativeFilter UriRelativeFilter: This value cannot be null.

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.

getAction

Added in API level 35
fun getAction(): Int

Return UriRelativeFilterGroup.ACTION_ALLOW if a URI is allowed when matched and UriRelativeFilterGroup.ACTION_BLOCK if a URI is blacked when matched.

Return
Int Value is android.content.UriRelativeFilterGroup#ACTION_ALLOW, or android.content.UriRelativeFilterGroup#ACTION_BLOCK

getUriRelativeFilters

Added in API level 35
fun getUriRelativeFilters(): MutableCollection<UriRelativeFilter!>

Returns a unmodifiable view of the UriRelativeFilters list in this group.

Return
MutableCollection<UriRelativeFilter!> This value cannot be null.

hashCode

Added in API level 35
fun hashCode(): Int
Return
Int a hash code value for this object.

matchData

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

Match all URI filter in this group against Intent.getData().

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

toString

Added in API level 35
fun toString(): String
Return
String a string representation of the object.