Added in API level 35

Summary: Constants | Ctors | Methods | Inherited Methods

UriRelativeFilter

Kotlin |Java

public final class UriRelativeFilter
extends Object

java.lang.Object
↳	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
`int`	`FRAGMENT` Value to indicate that the filter is to be applied to a URI fragment.
`int`	`PATH` Value to indicate that the filter is to be applied to a URI path.
`int`	`QUERY` Value to indicate that the filter is to be applied to a URI query.

Public constructors
`UriRelativeFilter(int uriPart, int patternType, String filter)` Creates a new UriRelativeFilter.

Public methods
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`String`	`getFilter()` The string used to filter the URI.
`int`	`getPatternType()` The pattern type of the filter.
`int`	`getUriPart()` The URI part this filter operates on.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`matchData(Uri data)` Match this URI filter against an Intent's data.
`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

FRAGMENT

Added in API level 35

public static final int FRAGMENT

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

Constant Value: 2 (0x00000002)

PATH

Added in API level 35

public static final int PATH

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

Constant Value: 0 (0x00000000)

QUERY

Added in API level 35

public static final int QUERY

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

Constant Value: 1 (0x00000001)

Public constructors

UriRelativeFilter

Added in API level 35

public UriRelativeFilter (int uriPart, 
                int patternType, 
                String filter)

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 `PATH`, `QUERY`, or `FRAGMENT`
`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 `PatternMatcher.PATTERN_LITERAL`, `PatternMatcher.PATTERN_PREFIX`, `PatternMatcher.PATTERN_SIMPLE_GLOB`, `PatternMatcher.PATTERN_ADVANCED_GLOB`, or `PatternMatcher.PATTERN_SUFFIX`
`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

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.

getFilter

Added in API level 35

public String getFilter ()

The string used to filter the URI.

Returns
`String`	This value cannot be `null`.

getPatternType

Added in API level 35

public int getPatternType ()

The pattern type of the filter.

Returns
`int`	Value is `PatternMatcher.PATTERN_LITERAL`, `PatternMatcher.PATTERN_PREFIX`, `PatternMatcher.PATTERN_SIMPLE_GLOB`, `PatternMatcher.PATTERN_ADVANCED_GLOB`, or `PatternMatcher.PATTERN_SUFFIX`

getUriPart

Added in API level 35

public int getUriPart ()

The URI part this filter operates on.

Returns
`int`	Value is `PATH`, `QUERY`, or `FRAGMENT`

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

Returns
`boolean`	true if there is a 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.