Force.com Apex Code Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Pattern Class

Represents a compiled representation of a regular expression.

Namespace

System

Pattern Methods

The following are methods for Pattern.

compile(String)

Compiles the regular expression into a Pattern object.

Signature

public static Pattern compile(String regExp)

Parameters

regExp
Type: String

Return Value

Type: System.Pattern

matcher(String)

Creates a Matcher object that matches the input string regExp against this Pattern object.

Signature

public Matcher matcher(String regExp)

Parameters

regExp
Type: String

Return Value

Type: Matcher

matches(String, String)

Compiles the regular expression regExp and tries to match it against s. This method returns true if the string s matches the regular expression, false otherwise.

Signature

public static Boolean matches(String regExp, String s)

Parameters

regExp
Type: String
s
Type: String

Return Value

Type: Boolean

Usage

If a pattern is to be used multiple times, compiling it once and reusing it is more efficient than invoking this method each time.

Example

Note that the following code example:

1Pattern.matches(regExp, input);

produces the same result as this code example:

1Pattern.compile(regex).
2matcher(input).matches();

pattern()

Returns the regular expression from which this Pattern object was compiled.

Signature

public String pattern()

Return Value

Type: String

quote(String)

Returns a string that can be used to create a pattern that matches the string s as if it were a literal pattern.

Signature

public static String quote(String s)

Parameters

s
Type: String

Return Value

Type: String

Usage

Metacharacters (such as $ or ^) and escape sequences in the input string are treated as literal characters with no special meaning.

split(String)

Returns a list that contains each substring of the String that matches this pattern.

Signature

public String[] split(String s)

Parameters

s
Type: String

Return Value

Type: String[]

Usage

The substrings are placed in the list in the order in which they occur in the String. If s does not match the pattern, the resulting list has just one element containing the original String.

split(String, Integer)

Returns a list that contains each substring of the String that is terminated either by the regular expression regExp that matches this pattern, or by the end of the String.

Signature

public String[] split(String regExp, Integer limit)

Parameters

regExp
Type: String
limit
Type: Integer
(Optional) Controls the number of times the pattern is applied and therefore affects the length of the list:
  • If limit is greater than zero, the pattern is applied at most limit - 1 times, the list's length is no greater than limit, and the list's last entry contains all input beyond the last matched delimiter.
  • If limit is non-positive then the pattern is applied as many times as possible and the list can have any length.
  • If limit is zero then the pattern is applied as many times as possible, the list can have any length, and trailing empty strings are discarded.

Return Value

Type: String[]