java.util.regex

Class Pattern

Implemented Interfaces:
Serializable

public final class Pattern
extends Object
implements Serializable

Compiled regular expression ready to be applied.
Since:
1.4
See Also:
Serialized Form

Field Summary

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

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

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CANON_EQ

public static final int CANON_EQ
Field Value:
128

CASE_INSENSITIVE

public static final int CASE_INSENSITIVE
Field Value:
2

COMMENTS

public static final int COMMENTS
Field Value:
4

DOTALL

public static final int DOTALL
Field Value:
32

MULTILINE

public static final int MULTILINE
Field Value:
8

UNICODE_CASE

public static final int UNICODE_CASE
Field Value:
64

UNIX_LINES

public static final int UNIX_LINES
Field Value:
1

Method Details

compile

public static Pattern compile(String regex)
            throws PatternSyntaxException
Parameters:
regex - The regular expression
Throws:
PatternSyntaxException - If the expression's syntax is invalid

compile

public static Pattern compile(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
IllegalArgumentException - If bit values other than those corresponding to the defined match flags are set in flags

flags

public int flags()

matcher

public Matcher matcher(CharSequence input)
Parameters:
input - The character sequence to be matched

matches

public static boolean matches(String regex,
                              CharSequence input)
Parameters:
regex - The regular expression
input - The character sequence to be matched
Throws:
PatternSyntaxException - If the expression's syntax is invalid

pattern

public String pattern()

quote

public static String quote(String str)
Returns a literal pattern for the specified String.
Parameters:
Returns:
a literal pattern for the specified String.
Throws:
NullPointerException - if str is null.
Since:
1.5

split

public String[] split(CharSequence input)
Parameters:
input - The character sequence to be matched

split

public String[] split(CharSequence input,
                      int limit)
Parameters:
input - The character sequence to be matched
limit - The result threshold

toString

public String toString()
Return the regular expression used to construct this object.
Overrides:
toString in interface Object
Since:
1.5

Pattern.java -- Compiled regular expression ready to be applied. Copyright (C) 2002, 2004, 2005, 2007, 2010 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.