java.util.regex

Class Pattern

java.lang.Object

java.util.regex.Pattern

All Implemented Interfaces:

java.io.Serializable

public final class Pattern
extends java.lang.Object
implements java.io.Serializable

Compiled regular expression ready to be applied.

Since:

1.4

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANON_EQ
static int	CASE_INSENSITIVE
static int	COMMENTS
static int	DOTALL
static int	MULTILINE
static int	UNICODE_CASE
static int	UNIX_LINES

Method Summary

Methods

Modifier and Type	Method and Description
static Pattern	compile(java.lang.String regex)
static Pattern	compile(java.lang.String regex, int flags)
int	flags()
Matcher	matcher(java.lang.CharSequence input)
static boolean	matches(java.lang.String regex, java.lang.CharSequence input)
java.lang.String	pattern()
static java.lang.String	quote(java.lang.String str) Returns a literal pattern for the specified String.
java.lang.String[]	split(java.lang.CharSequence input)
java.lang.String[]	split(java.lang.CharSequence input, int limit)
java.lang.String	toString() Return the regular expression used to construct this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CANON_EQ

public static final int CANON_EQ

See Also:

Constant Field Values

CASE_INSENSITIVE

public static final int CASE_INSENSITIVE

See Also:

Constant Field Values

COMMENTS

public static final int COMMENTS

See Also:

Constant Field Values

DOTALL

public static final int DOTALL

See Also:

Constant Field Values

MULTILINE

public static final int MULTILINE

See Also:

Constant Field Values

UNICODE_CASE

public static final int UNICODE_CASE

See Also:

Constant Field Values

UNIX_LINES

public static final int UNIX_LINES

See Also:

Constant Field Values

Method Detail

compile

public static Pattern compile(java.lang.String regex)
                       throws PatternSyntaxException

Parameters:

regex - The regular expression

Throws:

PatternSyntaxException - If the expression's syntax is invalid

compile

public static Pattern compile(java.lang.String regex,
              int flags)
                       throws PatternSyntaxException

Parameters:

regex - The regular expression

flags - The match flags, a bit mask

Throws:

PatternSyntaxException - If the expression's syntax is invalid

java.lang.IllegalArgumentException - If bit values other than those corresponding to the defined match flags are set in flags

flags

public int flags()

matches

public static boolean matches(java.lang.String regex,
              java.lang.CharSequence input)

Parameters:

regex - The regular expression

input - The character sequence to be matched

Throws:

PatternSyntaxException - If the expression's syntax is invalid

matcher

public Matcher matcher(java.lang.CharSequence input)

Parameters:

input - The character sequence to be matched

split

public java.lang.String[] split(java.lang.CharSequence input)

Parameters:

input - The character sequence to be matched

split

public java.lang.String[] split(java.lang.CharSequence input,
                       int limit)

Parameters:

input - The character sequence to be matched

limit - The result threshold

pattern

public java.lang.String pattern()

quote

public static java.lang.String quote(java.lang.String str)

Returns a literal pattern for the specified String.

Parameters:

String - to return a literal pattern for.

Returns:

a literal pattern for the specified String.

Throws:

java.lang.NullPointerException - if str is null.

Since:

1.5

toString

public java.lang.String toString()

Return the regular expression used to construct this object.

Overrides:

toString in class java.lang.Object

Returns:

the String representing this Object, which may be null

Since:

1.5

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)