Added in API level 35

Summary: Constants | Ctors | Methods | Inherited Methods

UriRelativeFilterGroup

Kotlin |Java

public final class UriRelativeFilterGroup
extends Object

java.lang.Object
↳	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
`int`	`ACTION_ALLOW` Value to indicate that the group match is allowed.
`int`	`ACTION_BLOCK` Value to indicate that the group match is blocked.

Public constructors
`UriRelativeFilterGroup(int action)` New UriRelativeFilterGroup that matches a Intent data.

Public methods
`void`	`addUriRelativeFilter(UriRelativeFilter uriRelativeFilter)` Add a filter to the group.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`getAction()` Return `UriRelativeFilterGroup.ACTION_ALLOW` if a URI is allowed when matched and `UriRelativeFilterGroup.ACTION_BLOCK` if a URI is blacked when matched.
`Collection<UriRelativeFilter>`	`getUriRelativeFilters()` Returns a unmodifiable view of the UriRelativeFilters list in this group.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`matchData(Uri data)` Match all URI filter in this group against `Intent.getData()`.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

ACTION_ALLOW

Added in API level 35

public static final int ACTION_ALLOW

Value to indicate that the group match is allowed.

Constant Value: 0 (0x00000000)

ACTION_BLOCK

Added in API level 35

public static final int ACTION_BLOCK

Value to indicate that the group match is blocked.

Constant Value: 1 (0x00000001)

Public constructors

UriRelativeFilterGroup

Added in API level 35

public UriRelativeFilterGroup (int action)

New UriRelativeFilterGroup that matches a Intent data.

Parameters
`action`	`int`: Whether this matching group should be allowed or disallowed. Value is `ACTION_ALLOW`, or `ACTION_BLOCK`

Public methods

addUriRelativeFilter

Added in API level 35

public void addUriRelativeFilter (UriRelativeFilter uriRelativeFilter)

Add a filter to the group.

Parameters
`uriRelativeFilter`	`UriRelativeFilter`: This value cannot be `null`.

equals

Added in API level 35

public boolean equals (Object o)

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
`o`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getAction

Added in API level 35

public int getAction ()

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

Returns
`int`	Value is `ACTION_ALLOW`, or `ACTION_BLOCK`

getUriRelativeFilters

Added in API level 35

public Collection<UriRelativeFilter> getUriRelativeFilters ()

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

Returns
`Collection<UriRelativeFilter>`	This value cannot be `null`.

hashCode

Added in API level 35

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
`int`	a hash code value for this object.

matchData

Added in API level 35

public boolean matchData (Uri data)

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`.

Returns
`boolean`	true if all filters match.

toString

Added in API level 35

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.