Java Doc for Pattern.java in  » 6.0-JDK-Core » Collections-Jar-Zip-Logging-regex » java » util » regex » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » Collections Jar Zip Logging regex » java.util.regex 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.regex.Pattern

Pattern
final public class Pattern implements java.io.Serializable(Code)
A compiled representation of a regular expression.

A regular expression, specified as a string, must first be compiled into an instance of this class. The resulting pattern can then be used to create a Matcher object that can match arbitrary java.lang.CharSequence character sequences against the regular expression. All of the state involved in performing a match resides in the matcher, so many matchers can share the same pattern.

A typical invocation sequence is thus

 Pattern p = Pattern.
Pattern.compile compile ("a*b");
 Matcher m = p.
Pattern.matcher matcher ("aaaaab");
 boolean b = m.
Matcher.matches matches ();

A Pattern.matches matches method is defined by this class as a convenience for when a regular expression is used just once. This method compiles an expression and matches an input sequence against it in a single invocation. The statement

 boolean b = Pattern.matches("a*b", "aaaaab");
is equivalent to the three statements above, though for repeated matches it is less efficient since it does not allow the compiled pattern to be reused.

Instances of this class are immutable and are safe for use by multiple concurrent threads. Instances of the Matcher class are not safe for such use.

Summary of regular-expression constructs

Construct Matches
 
Characters
x The character x
\\ The backslash character
\0n The character with octal value 0n (0 <= n <= 7)
\0nn The character with octal value 0nn (0 <= n <= 7)
\0mnn The character with octal value 0mnn (0 <= m <= 3, 0 <= n <= 7)
\xhh The character with hexadecimal value 0xhh
\uhhhh The character with hexadecimal value 0xhhhh
\t The tab character ('\u0009')
\n The newline (line feed) character ('\u000A')
\r The carriage-return character ('\u000D')
\f The form-feed character ('\u000C')
\a The alert (bell) character ('\u0007')
\e The escape character ('\u001B')
\cx The control character corresponding to x
 
Character classes
[abc] a, b, or c (simple class)
[^abc] Any character except a, b, or c (negation)
[a-zA-Z] a through z or A through Z, inclusive (range)
[a-d[m-p]] a through d, or m through p: [a-dm-p] (union)
[a-z&&[def]] d, e, or f (intersection)
[a-z&&[^bc]] a through z, except for b and c: [ad-z] (subtraction)
[a-z&&[^m-p]] a through z, and not m through p: [a-lq-z](subtraction)
 
Predefined character classes
. Any character (may or may not match line terminators)
\d A digit: [0-9]
\D A non-digit: [^0-9]
\s A whitespace character: [ \t\n\x0B\f\r]
\S A non-whitespace character: [^\s]
\w A word character: [a-zA-Z_0-9]
\W A non-word character: [^\w]
 
POSIX character classes (US-ASCII only)
\p{Lower} A lower-case alphabetic character: [a-z]
\p{Upper} An upper-case alphabetic character:[A-Z]
\p{ASCII} All ASCII:[\x00-\x7F]
\p{Alpha} An alphabetic character:[\p{Lower}\p{Upper}]
\p{Digit} A decimal digit: [0-9]
\p{Alnum} An alphanumeric character:[\p{Alpha}\p{Digit}]
\p{Punct} Punctuation: One of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
\p{Graph} A visible character: [\p{Alnum}\p{Punct}]
\p{Print} A printable character: [\p{Graph}\x20]
\p{Blank} A space or a tab: [ \t]
\p{Cntrl} A control character: [\x00-\x1F\x7F]
\p{XDigit} A hexadecimal digit: [0-9a-fA-F]
\p{Space} A whitespace character: [ \t\n\x0B\f\r]
 
java.lang.Character classes (simple java character type)
\p{javaLowerCase} Equivalent to java.lang.Character.isLowerCase()
\p{javaUpperCase} Equivalent to java.lang.Character.isUpperCase()
\p{javaWhitespace} Equivalent to java.lang.Character.isWhitespace()
\p{javaMirrored} Equivalent to java.lang.Character.isMirrored()
 
Classes for Unicode blocks and categories
\p{InGreek} A character in the Greek block (simple block)
\p{Lu} An uppercase letter (simple category)
\p{Sc} A currency symbol
\P{InGreek} Any character except one in the Greek block (negation)
[\p{L}&&[^\p{Lu}]]  Any letter except an uppercase letter (subtraction)
 
Boundary matchers
^ The beginning of a line
$ The end of a line
\b A word boundary
\B A non-word boundary
\A The beginning of the input
\G The end of the previous match
\Z The end of the input but for the final terminator, if any
\z The end of the input
 
Greedy quantifiers
X? X, once or not at all
X* X, zero or more times
X+ X, one or more times
X{n} X, exactly n times
X{n,} X, at least n times
X{n,m} X, at least n but not more than m times
 
Reluctant quantifiers
X?? X, once or not at all
X*? X, zero or more times
X+? X, one or more times
X{n}? X, exactly n times
X{n,}? X, at least n times
X{n,m}? X, at least n but not more than m times
 
Possessive quantifiers
X?+ X, once or not at all
X*+ X, zero or more times
X++ X, one or more times
X{n}+ X, exactly n times
X{n,}+ X, at least n times
X{n,m}+ X, at least n but not more than m times
 
Logical operators
XY X followed by Y
X|Y Either X or Y
(X) X, as a capturing group
 
Back references
\n Whatever the nth capturing group matched
 
Quotation
\ Nothing, but quotes the following character
\Q Nothing, but quotes all characters until \E
\E Nothing, but ends quoting started by \Q
 
Special constructs (non-capturing)
(?:X) X, as a non-capturing group
(?idmsux-idmsux)  Nothing, but turns match flags i d m s u x on - off
(?idmsux-idmsux:X)   X, as a non-capturing group with the given flags i d m s u x on - off
(?=X) X, via zero-width positive lookahead
(?!X) X, via zero-width negative lookahead
(?<=X) X, via zero-width positive lookbehind
(?<!X) X, via zero-width negative lookbehind
(?>X) X, as an independent, non-capturing group

Backslashes, escapes, and quoting

The backslash character ('\') serves to introduce escaped constructs, as defined in the table above, as well as to quote characters that otherwise would be interpreted as unescaped constructs. Thus the expression \\ matches a single backslash and \{ matches a left brace.

It is an error to use a backslash prior to any alphabetic character that does not denote an escaped construct; these are reserved for future extensions to the regular-expression language. A backslash may be used prior to a non-alphabetic character regardless of whether that character is part of an unescaped construct.

Backslashes within string literals in Java source code are interpreted as required by the Java Language Specification as either Unicode escapes or other character escapes. It is therefore necessary to double backslashes in string literals that represent regular expressions to protect them from interpretation by the Java bytecode compiler. The string literal "\b", for example, matches a single backspace character when interpreted as a regular expression, while "\\b" matches a word boundary. The string literal "\(hello\)" is illegal and leads to a compile-time error; in order to match the string (hello) the string literal "\\(hello\\)" must be used.

Character Classes

Character classes may appear within other character classes, and may be composed by the union operator (implicit) and the intersection operator (&&). The union operator denotes a class that contains every character that is in at least one of its operand classes. The intersection operator denotes a class that contains every character that is in both of its operand classes.

The precedence of character-class operators is as follows, from highest to lowest:

1     Literal escape     \x
2     Grouping [...]
3     Range a-z
4     Union [a-e][i-u]
5     Intersection [a-z&&[aeiou]]

Note that a different set of metacharacters are in effect inside a character class than outside a character class. For instance, the regular expression . loses its special meaning inside a character class, while the expression - becomes a range forming metacharacter.

Line terminators

A line terminator is a one- or two-character sequence that marks the end of a line of the input character sequence. The following are recognized as line terminators:

  • A newline (line feed) character ('\n'),
  • A carriage-return character followed immediately by a newline character ("\r\n"),
  • A standalone carriage-return character ('\r'),
  • A next-line character ('\u0085'),
  • A line-separator character ('\u2028'), or
  • A paragraph-separator character ('\u2029).

If Pattern.UNIX_LINES mode is activated, then the only line terminators recognized are newline characters.

The regular expression . matches any character except a line terminator unless the Pattern.DOTALL flag is specified.

By default, the regular expressions ^ and $ ignore line terminators and only match at the beginning and the end, respectively, of the entire input sequence. If Pattern.MULTILINE mode is activated then ^ matches at the beginning of input and after any line terminator except at the end of input. When in Pattern.MULTILINE mode $ matches just before a line terminator or the end of the input sequence.

Groups and capturing

Capturing groups are numbered by counting their opening parentheses from left to right. In the expression ((A)(B(C))), for example, there are four such groups:

1     ((A)(B(C)))
2     (A)
3     (B(C))
4     (C)

Group zero always stands for the entire expression.

Capturing groups are so named because, during a match, each subsequence of the input sequence that matches such a group is saved. The captured subsequence may be used later in the expression, via a back reference, and may also be retrieved from the matcher once the match operation is complete.

The captured input associated with a group is always the subsequence that the group most recently matched. If a group is evaluated a second time because of quantification then its previously-captured value, if any, will be retained if the second evaluation fails. Matching the string "aba" against the expression (a(b)?)+, for example, leaves group two set to "b". All captured input is discarded at the beginning of each match.

Groups beginning with (? are pure, non-capturing groups that do not capture text and do not count towards the group total.

Unicode support

This class is in conformance with Level 1 of Unicode Technical Standard #18: Unicode Regular Expression Guidelines, plus RL2.1 Canonical Equivalents.

Unicode escape sequences such as \u2014 in Java source code are processed as described in \u00A73.3 of the Java Language Specification. Such escape sequences are also implemented directly by the regular-expression parser so that Unicode escapes can be used in expressions that are read from files or from the keyboard. Thus the strings "\u2014" and "\\u2014", while not equal, compile into the same pattern, which matches the character with hexadecimal value 0x2014.

Unicode blocks and categories are written with the \p and \P constructs as in Perl. \p{prop} matches if the input has the property prop, while \P{prop} does not match if the input has that property. Blocks are specified with the prefix In, as in InMongolian. Categories may be specified with the optional prefix Is: Both \p{L} and \p{IsL} denote the category of Unicode letters. Blocks and categories can be used both inside and outside of a character class.

The supported categories are those of The Unicode Standard in the version specified by the java.lang.Character Character class. The category names are those defined in the Standard, both normative and informative. The block names supported by Pattern are the valid block names accepted and defined by java.lang.Character.UnicodeBlock.forName(String) UnicodeBlock.forName .

Categories that behave like the java.lang.Character boolean ismethodname methods (except for the deprecated ones) are available through the same \p{prop} syntax where the specified property has the name javamethodname.

Comparison to Perl 5

The Pattern engine performs traditional NFA-based matching with ordered alternation as occurs in Perl 5.

Perl constructs not supported by this class:

  • The conditional constructs (?{X}) and (?(condition)X|Y),

  • The embedded code constructs (?{code}) and (??{code}),

  • The embedded comment syntax (?#comment), and

  • The preprocessing operations \l \u, \L, and \U.

Constructs supported by this class but not by Perl:

Notable differences from Perl:

  • In Perl, \1 through \9 are always interpreted as back references; a backslash-escaped number greater than 9 is treated as a back reference if at least that many subexpressions exist, otherwise it is interpreted, if possible, as an octal escape. In this class octal escapes must always begin with a zero. In this class, \1 through \9 are always interpreted as back references, and a larger number is accepted as a back reference if at least that many subexpressions exist at that point in the regular expression, otherwise the parser will drop digits until the number is smaller or equal to the existing number of groups or it is one digit.

  • Perl uses the g flag to request a match that resumes where the last match left off. This functionality is provided implicitly by the Matcher class: Repeated invocations of the Matcher.find find method will resume where the last match left off, unless the matcher is reset.

  • In Perl, embedded flags at the top level of an expression affect the whole expression. In this class, embedded flags always take effect at the point at which they appear, whether they are at the top level or within a group; in the latter case, flags are restored at the end of the group just as in Perl.

  • Perl is forgiving about malformed matching constructs, as in the expression *a, as well as dangling brackets, as in the expression abc], and treats them as literals. This class also accepts dangling brackets but is strict about dangling metacharacters like +, ? and *, and will throw a PatternSyntaxException if it encounters them.

For a more precise description of the behavior of regular expression constructs, please see Mastering Regular Expressions, 3nd Edition, Jeffrey E. F. Friedl, O'Reilly and Associates, 2006.


See Also:   java.lang.String.split(Stringint)
See Also:   java.lang.String.split(String)
author:
   Mike McCloskey
author:
   Mark Reinhold
author:
   JSR-51 Expert Group
version:
   1.133, 07/05/05
since:
   1.4

Inner Class :final static class TreeInfo
Inner Class :static class Node extends Object
Inner Class :static class LastNode extends Node
Inner Class :static class Start extends Node
Inner Class :final static class StartS extends Start
Inner Class :final static class Begin extends Node
Inner Class :final static class End extends Node
Inner Class :final static class Caret extends Node
Inner Class :final static class UnixCaret extends Node
Inner Class :final static class LastMatch extends Node
Inner Class :final static class Dollar extends Node
Inner Class :final static class UnixDollar extends Node
Inner Class :final static class SingleS extends CharProperty
Inner Class :final static class Single extends BmpCharProperty
Inner Class :final static class SingleI extends BmpCharProperty
Inner Class :final static class SingleU extends CharProperty
Inner Class :final static class Category extends CharProperty
Inner Class :final static class Ctype extends BmpCharProperty
Inner Class :static class SliceNode extends Node
Inner Class :final static class Slice extends SliceNode
Inner Class :static class SliceI extends SliceNode
Inner Class :final static class SliceU extends SliceNode
Inner Class :final static class SliceS extends SliceNode
Inner Class :static class SliceIS extends SliceNode
Inner Class :final static class SliceUS extends SliceIS
Inner Class :final static class All extends CharProperty
Inner Class :final static class Dot extends CharProperty
Inner Class :final static class UnixDot extends CharProperty
Inner Class :final static class Ques extends Node
Inner Class :final static class Curly extends Node
Inner Class :final static class GroupCurly extends Node
Inner Class :final static class BranchConn extends Node
Inner Class :final static class Branch extends Node
Inner Class :final static class GroupHead extends Node
Inner Class :final static class GroupRef extends Node
Inner Class :final static class GroupTail extends Node
Inner Class :final static class Prolog extends Node
Inner Class :static class Loop extends Node
Inner Class :final static class LazyLoop extends Loop
Inner Class :static class BackRef extends Node
Inner Class :static class CIBackRef extends Node
Inner Class :final static class First extends Node
Inner Class :final static class Conditional extends Node
Inner Class :final static class Pos extends Node
Inner Class :final static class Neg extends Node
Inner Class :static class Behind extends Node
Inner Class :final static class BehindS extends Behind
Inner Class :static class NotBehind extends Node
Inner Class :final static class NotBehindS extends NotBehind
Inner Class :final static class Bound extends Node
Inner Class :static class BnM extends Node
Inner Class :final static class BnMS extends BnM

Field Summary
final public static  intCANON_EQ
     Enables canonical equivalence.

When this flag is specified then two characters will be considered to match if, and only if, their full canonical decompositions match. The expression "a\u030A", for example, will match the string "\u00E5" when this flag is specified.

final public static  intCASE_INSENSITIVE
     Enables case-insensitive matching.

By default, case-insensitive matching assumes that only characters in the US-ASCII charset are being matched.

final public static  intCOMMENTS
     Permits whitespace and comments in pattern.
final public static  intDOTALL
     Enables dotall mode.

In dotall mode, the expression . matches any character, including a line terminator.

final static  intGREEDY
    
final static  intINDEPENDENT
    
final static  intLAZY
    
final public static  intLITERAL
     Enables literal parsing of the pattern.

When this flag is specified then the input string that specifies the pattern is treated as a sequence of literal characters. Metacharacters or escape sequences in the input sequence will be given no special meaning.

The flags CASE_INSENSITIVE and UNICODE_CASE retain their impact on matching when used in conjunction with this flag.

final static  intMAX_REPS
    
final public static  intMULTILINE
     Enables multiline mode.

In multiline mode the expressions ^ and $ match just after or just before, respectively, a line terminator or the end of the input sequence.

final static  intPOSSESSIVE
    
final public static  intUNICODE_CASE
     Enables Unicode-aware case folding.

When this flag is specified then case-insensitive matching, when enabled by the Pattern.CASE_INSENSITIVE flag, is done in a manner consistent with the Unicode Standard.

final public static  intUNIX_LINES
     Enables Unix lines mode.
static  Nodeaccept
     This must be the very first initializer.
transient  int[]buffer
     Temporary storage used by parsing pattern slice.
transient  intcapturingGroupCount
     The number of capturing groups in this Pattern.
transient  GroupHead[]groupNodes
     Temporary storage used while parsing group references.
static  NodelastAccept
    
transient  intlocalCount
     The local variable count used by parsing tree.
static  NodelookbehindEnd
     For use with lookbehinds; matches the position where the lookbehind was encountered.
transient  NodematchRoot
     The root of object tree for a match operation.
transient  Noderoot
     The starting point of state machine for the find operation.


Method Summary
public static  Patterncompile(String regex)
     Compiles the given regular expression into a pattern.
public static  Patterncompile(String regex, int flags)
     Compiles the given regular expression into a pattern with the given flags.
public  intflags()
     Returns this pattern's match flags.
public  Matchermatcher(CharSequence input)
     Creates a matcher that will match the given input against this pattern.
public static  booleanmatches(String regex, CharSequence input)
     Compiles the given regular expression and attempts to match the given input against it.

An invocation of this convenience method of the form

 Pattern.matches(regex, input);
behaves in exactly the same way as the expression
 Pattern.compile(regex).matcher(input).matches()

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

public  Stringpattern()
     Returns the regular expression from which this pattern was compiled.
public static  Stringquote(String s)
     Returns a literal pattern String for the specified String.
public  String[]split(CharSequence input, int limit)
     Splits the given input sequence around matches of this pattern.

The array returned by this method contains each substring of the input sequence that is terminated by another subsequence that matches this pattern or is terminated by the end of the input sequence.

public  String[]split(CharSequence input)
     Splits the given input sequence around matches of this pattern.

This method works as if by invoking the two-argument Pattern.split(java.lang.CharSequence,int) split method with the given input sequence and a limit argument of zero.

public  StringtoString()
    

Returns the string representation of this pattern.


Field Detail
CANON_EQ
final public static int CANON_EQ(Code)
Enables canonical equivalence.

When this flag is specified then two characters will be considered to match if, and only if, their full canonical decompositions match. The expression "a\u030A", for example, will match the string "\u00E5" when this flag is specified. By default, matching does not take canonical equivalence into account.

There is no embedded flag character for enabling canonical equivalence.

Specifying this flag may impose a performance penalty.




CASE_INSENSITIVE
final public static int CASE_INSENSITIVE(Code)
Enables case-insensitive matching.

By default, case-insensitive matching assumes that only characters in the US-ASCII charset are being matched. Unicode-aware case-insensitive matching can be enabled by specifying the Pattern.UNICODE_CASE flag in conjunction with this flag.

Case-insensitive matching can also be enabled via the embedded flag expression (?i).

Specifying this flag may impose a slight performance penalty.




COMMENTS
final public static int COMMENTS(Code)
Permits whitespace and comments in pattern.

In this mode, whitespace is ignored, and embedded comments starting with # are ignored until the end of a line.

Comments mode can also be enabled via the embedded flag expression (?x).




DOTALL
final public static int DOTALL(Code)
Enables dotall mode.

In dotall mode, the expression . matches any character, including a line terminator. By default this expression does not match line terminators.

Dotall mode can also be enabled via the embedded flag expression (?s). (The s is a mnemonic for "single-line" mode, which is what this is called in Perl.)




GREEDY
final static int GREEDY(Code)



INDEPENDENT
final static int INDEPENDENT(Code)



LAZY
final static int LAZY(Code)



LITERAL
final public static int LITERAL(Code)
Enables literal parsing of the pattern.

When this flag is specified then the input string that specifies the pattern is treated as a sequence of literal characters. Metacharacters or escape sequences in the input sequence will be given no special meaning.

The flags CASE_INSENSITIVE and UNICODE_CASE retain their impact on matching when used in conjunction with this flag. The other flags become superfluous.

There is no embedded flag character for enabling literal parsing.
since:
   1.5




MAX_REPS
final static int MAX_REPS(Code)



MULTILINE
final public static int MULTILINE(Code)
Enables multiline mode.

In multiline mode the expressions ^ and $ match just after or just before, respectively, a line terminator or the end of the input sequence. By default these expressions only match at the beginning and the end of the entire input sequence.

Multiline mode can also be enabled via the embedded flag expression (?m).




POSSESSIVE
final static int POSSESSIVE(Code)



UNICODE_CASE
final public static int UNICODE_CASE(Code)
Enables Unicode-aware case folding.

When this flag is specified then case-insensitive matching, when enabled by the Pattern.CASE_INSENSITIVE flag, is done in a manner consistent with the Unicode Standard. By default, case-insensitive matching assumes that only characters in the US-ASCII charset are being matched.

Unicode-aware case folding can also be enabled via the embedded flag expression (?u).

Specifying this flag may impose a performance penalty.




UNIX_LINES
final public static int UNIX_LINES(Code)
Enables Unix lines mode.

In this mode, only the '\n' line terminator is recognized in the behavior of ., ^, and $.

Unix lines mode can also be enabled via the embedded flag expression (?d).




accept
static Node accept(Code)
This must be the very first initializer.



buffer
transient int[] buffer(Code)
Temporary storage used by parsing pattern slice.



capturingGroupCount
transient int capturingGroupCount(Code)
The number of capturing groups in this Pattern. Used by matchers to allocate storage needed to perform a match.



groupNodes
transient GroupHead[] groupNodes(Code)
Temporary storage used while parsing group references.



lastAccept
static Node lastAccept(Code)



localCount
transient int localCount(Code)
The local variable count used by parsing tree. Used by matchers to allocate storage needed to perform a match.



lookbehindEnd
static Node lookbehindEnd(Code)
For use with lookbehinds; matches the position where the lookbehind was encountered.



matchRoot
transient Node matchRoot(Code)
The root of object tree for a match operation. The pattern is matched at the beginning. This may include a find that uses BnM or a First node.



root
transient Node root(Code)
The starting point of state machine for the find operation. This allows a match to start anywhere in the input.





Method Detail
compile
public static Pattern compile(String regex)(Code)
Compiles the given regular expression into a pattern.


Parameters:
  regex - The expression to be compiled
throws:
  PatternSyntaxException - If the expression's syntax is invalid



compile
public static Pattern compile(String regex, int flags)(Code)
Compiles the given regular expression into a pattern with the given flags.


Parameters:
  regex - The expression to be compiled
Parameters:
  flags - Match flags, a bit mask that may includePattern.CASE_INSENSITIVE, Pattern.MULTILINE, Pattern.DOTALL,Pattern.UNICODE_CASE, Pattern.CANON_EQ, Pattern.UNIX_LINES,Pattern.LITERAL and Pattern.COMMENTS
throws:
  IllegalArgumentException - If bit values other than those corresponding to the definedmatch flags are set in flags
throws:
  PatternSyntaxException - If the expression's syntax is invalid



flags
public int flags()(Code)
Returns this pattern's match flags.

The match flags specified when this pattern was compiled



matcher
public Matcher matcher(CharSequence input)(Code)
Creates a matcher that will match the given input against this pattern.


Parameters:
  input - The character sequence to be matched A new matcher for this pattern



matches
public static boolean matches(String regex, CharSequence input)(Code)
Compiles the given regular expression and attempts to match the given input against it.

An invocation of this convenience method of the form

 Pattern.matches(regex, input);
behaves in exactly the same way as the expression
 Pattern.compile(regex).matcher(input).matches()

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


Parameters:
  regex - The expression to be compiled
Parameters:
  input - The character sequence to be matched
throws:
  PatternSyntaxException - If the expression's syntax is invalid



pattern
public String pattern()(Code)
Returns the regular expression from which this pattern was compiled.

The source of this pattern



quote
public static String quote(String s)(Code)
Returns a literal pattern String for the specified String.

This method produces a String that can be used to create a Pattern that would match the string s as if it were a literal pattern.

Metacharacters or escape sequences in the input sequence will be given no special meaning.
Parameters:
  s - The string to be literalized A literal string replacement
since:
   1.5



split
public String[] split(CharSequence input, int limit)(Code)
Splits the given input sequence around matches of this pattern.

The array returned by this method contains each substring of the input sequence that is terminated by another subsequence that matches this pattern or is terminated by the end of the input sequence. The substrings in the array are in the order in which they occur in the input. If this pattern does not match any subsequence of the input then the resulting array has just one element, namely the input sequence in string form.

The limit parameter controls the number of times the pattern is applied and therefore affects the length of the resulting array. If the limit n is greater than zero then the pattern will be applied at most n - 1 times, the array's length will be no greater than n, and the array's last entry will contain all input beyond the last matched delimiter. If n is non-positive then the pattern will be applied as many times as possible and the array can have any length. If n is zero then the pattern will be applied as many times as possible, the array can have any length, and trailing empty strings will be discarded.

The input "boo:and:foo", for example, yields the following results with these parameters:

Regex    

Limit    

Result    

: 2 { "boo", "and:foo" }
: 5 { "boo", "and", "foo" }
: -2 { "boo", "and", "foo" }
o 5 { "b", "", ":and:f", "", "" }
o -2 { "b", "", ":and:f", "", "" }
o 0 { "b", "", ":and:f" }

Parameters:
  input - The character sequence to be split
Parameters:
  limit - The result threshold, as described above The array of strings computed by splitting the inputaround matches of this pattern



split
public String[] split(CharSequence input)(Code)
Splits the given input sequence around matches of this pattern.

This method works as if by invoking the two-argument Pattern.split(java.lang.CharSequence,int) split method with the given input sequence and a limit argument of zero. Trailing empty strings are therefore not included in the resulting array.

The input "boo:and:foo", for example, yields the following results with these expressions:

Regex    

Result

: { "boo", "and", "foo" }
o { "b", "", ":and:f" }

Parameters:
  input - The character sequence to be split The array of strings computed by splitting the inputaround matches of this pattern



toString
public String toString()(Code)

Returns the string representation of this pattern. This is the regular expression from which this pattern was compiled.

The string representation of this pattern
since:
   1.5



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.