Added in API level 1

PatternMatcher

Kotlin |Java

public class PatternMatcher
extends Object implements Parcelable

java.lang.Object
↳	android.os.PatternMatcher

Known direct subclasses

PathPermission

PathPermission Description of permissions needed to access a particular path in a ProviderInfo.

A simple pattern matcher, which is safe to use on untrusted data: it does not provide full reg-exp support, only simple globbing that can not be used maliciously.

Summary

Constants
`int`	`PATTERN_ADVANCED_GLOB` Pattern type: the given pattern is interpreted with a regular expression-like syntax for matching against the string it is tested against.
`int`	`PATTERN_LITERAL` Pattern type: the given pattern must exactly match the string it is tested against.
`int`	`PATTERN_PREFIX` Pattern type: the given pattern must match the beginning of the string it is tested against.
`int`	`PATTERN_SIMPLE_GLOB` Pattern type: the given pattern is interpreted with a simple glob syntax for matching against the string it is tested against.
`int`	`PATTERN_SUFFIX` Pattern type: the given pattern must match the end of the string it is tested against.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<PatternMatcher>`	`CREATOR`

Public constructors
`PatternMatcher(Parcel src)`
`PatternMatcher(String pattern, int type)`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`final String`	`getPath()`
`final int`	`getType()`
`boolean`	`match(String str)`
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

PATTERN_ADVANCED_GLOB

Added in API level 26

public static final int PATTERN_ADVANCED_GLOB

Pattern type: the given pattern is interpreted with a regular expression-like syntax for matching against the string it is tested against. Supported tokens include dot (.) and sets ([...]) with full support for character ranges and the not (^) modifier. Supported modifiers include star (*) for zero-or-more, plus (+) for one-or-more and full range ({...}) support. This is a simple evaluation implementation in which matching is done against the pattern in real time with no backtracking support.

Constant Value: 3 (0x00000003)

PATTERN_LITERAL

Added in API level 1

public static final int PATTERN_LITERAL

Pattern type: the given pattern must exactly match the string it is tested against.

Constant Value: 0 (0x00000000)

PATTERN_PREFIX

Added in API level 1

public static final int PATTERN_PREFIX

Pattern type: the given pattern must match the beginning of the string it is tested against.

Constant Value: 1 (0x00000001)

PATTERN_SIMPLE_GLOB

Added in API level 1

public static final int PATTERN_SIMPLE_GLOB

Pattern type: the given pattern is interpreted with a simple glob syntax for matching against the string it is tested against. In this syntax, you can use the '*' character to match against zero or more occurrences of the character immediately before. If the character before it is '.' it will match any character. The character '\' can be used as an escape. This essentially provides only the '*' wildcard part of a normal regexp.

Constant Value: 2 (0x00000002)

PATTERN_SUFFIX

Added in API level 31

public static final int PATTERN_SUFFIX

Pattern type: the given pattern must match the end of the string it is tested against.

Constant Value: 4 (0x00000004)

Fields

CREATOR

Added in API level 1

public static final Creator<PatternMatcher> CREATOR

Public constructors

PatternMatcher

Added in API level 1

public PatternMatcher (Parcel src)

Parameters
`src`	`Parcel`

PatternMatcher

Added in API level 1

public PatternMatcher (String pattern, 
                int type)

Parameters
`pattern`	`String`
`type`	`int`

Public methods

describeContents

Added in API level 1

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getPath

Added in API level 1

public final String getPath ()

Returns
`String`

getType

Added in API level 1

public final int getType ()

Returns
`int`

match

Added in API level 1

public boolean match (String str)

Parameters
`str`	`String`

Returns
`boolean`

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 1

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES