lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

PatternMatcher

public class PatternMatcher
extends Object implements Parcelable

java.lang.Object
   ↳ android.os.PatternMatcher


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.

Inherited constants

Fields

public static final Creator<PatternMatcher> CREATOR

Public constructors

PatternMatcher(String pattern, int type)
PatternMatcher(Parcel src)

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

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)

Fields

CREATOR

added in API level 1
public static final Creator<PatternMatcher> CREATOR

Public constructors

PatternMatcher

added in API level 1
public PatternMatcher (String pattern, 
                int type)

Parameters
pattern String

type int

PatternMatcher

added in API level 1
public PatternMatcher (Parcel src)

Parameters
src Parcel

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

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. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.