public class RegularExpression extends Object implements Serializable
RegularExpression re = new RegularExpression(regex);
if (re.matches(text)) { ... }
RegularExpression re = new RegularExpression(regex);
Match match = new Match();
if (re.matches(text, match)) {
... // You can refer captured texts with methods of the Match class.
}
RegularExpression re = new RegularExpression(regex, "i");
if (re.matches(text) >= 0) { ...}
You can specify options to RegularExpression(regex, options)
or setPattern(regex, options).
This options parameter consists of the following characters.
"i"
"m"
"s"
"u"
"w"
","
"X"
match() method does not do subsring matching
but entire string matching.
Differences from the Perl 5 regular expression
|
Meta characters are `. * + ? { [ ( ) | \ ^ $'.
This range matches the character.
This range matches a character which has a code point that is >= C1's code point and <= C2's code point. + *
...
These expressions specifies the same ranges as the following expressions.
Enumerated ranges are merged (union operation). [a-ec-z] is equivalent to [a-z]
Match instance
after matches(String,Match).
The 0th group means whole of this regular expression.
The Nth gorup is the inside of the Nth left parenthesis.
For instance, a regular expression is " *([^<:]*) +<([^>]*)> *" and target text is "From: TAMURA Kent <kent@trl.ibm.co.jp>":
Match.getCapturedText(0):
" TAMURA Kent <kent@trl.ibm.co.jp>"
Match.getCapturedText(1): "TAMURA Kent"
Match.getCapturedText(2): "kent@trl.ibm.co.jp"
regex ::= ('(?' options ')')? term ('|' term)*
term ::= factor+
factor ::= anchors | atom (('*' | '+' | '?' | minmax ) '?'? )?
| '(?#' [^)]* ')'
minmax ::= '{' ([0-9]+ | [0-9]+ ',' | ',' [0-9]+ | [0-9]+ ',' [0-9]+) '}'
atom ::= char | '.' | char-class | '(' regex ')' | '(?:' regex ')' | '\' [0-9]
| '\w' | '\W' | '\d' | '\D' | '\s' | '\S' | category-block | '\X'
| '(?>' regex ')' | '(?' options ':' regex ')'
| '(?' ('(' [0-9] ')' | '(' anchors ')' | looks) term ('|' term)? ')'
options ::= [imsw]* ('-' [imsw]+)?
anchors ::= '^' | '$' | '\A' | '\Z' | '\z' | '\b' | '\B' | '\<' | '\>'
looks ::= '(?=' regex ')' | '(?!' regex ')'
| '(?<=' regex ')' | '(?<!' regex ')'
char ::= '\\' | '\' [efnrtv] | '\c' [@-_] | code-point | character-1
category-block ::= '\' [pP] category-symbol-1
| ('\p{' | '\P{') (category-symbol | block-name
| other-properties) '}'
category-symbol-1 ::= 'L' | 'M' | 'N' | 'Z' | 'C' | 'P' | 'S'
category-symbol ::= category-symbol-1 | 'Lu' | 'Ll' | 'Lt' | 'Lm' | Lo'
| 'Mn' | 'Me' | 'Mc' | 'Nd' | 'Nl' | 'No'
| 'Zs' | 'Zl' | 'Zp' | 'Cc' | 'Cf' | 'Cn' | 'Co' | 'Cs'
| 'Pd' | 'Ps' | 'Pe' | 'Pc' | 'Po'
| 'Sm' | 'Sc' | 'Sk' | 'So'
block-name ::= (See above)
other-properties ::= 'ALL' | 'ASSIGNED' | 'UNASSIGNED'
character-1 ::= (any character except meta-characters)
char-class ::= '[' ranges ']'
| '(?[' ranges ']' ([-+&] '[' ranges ']')? ')'
ranges ::= '^'? (range ','?)+
range ::= '\d' | '\w' | '\s' | '\D' | '\W' | '\S' | category-block
| range-char | range-char '-' range-char
range-char ::= '\[' | '\]' | '\\' | '\' [,-efnrtv] | code-point | character-2
code-point ::= '\x' hex-char hex-char
| '\x{' hex-char+ '}'
| '\v' hex-char hex-char hex-char hex-char hex-char hex-char
hex-char ::= [0-9a-fA-F]
character-2 ::= (any character except \[]-,)
| Constructor and Description |
|---|
RegularExpression(String regex)
Creates a new RegularExpression instance.
|
RegularExpression(String regex,
String options)
Creates a new RegularExpression instance with options.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj)
Return true if patterns are the same and the options are equivalent.
|
int |
getNumberOfGroups()
Return the number of regular expression groups.
|
String |
getOptions()
Returns a option string.
|
String |
getPattern() |
int |
hashCode() |
boolean |
matches(char[] target)
Checks whether the target text contains this pattern or not.
|
boolean |
matches(char[] target,
int start,
int end)
Checks whether the target text contains this pattern
in specified range or not.
|
boolean |
matches(char[] target,
int start,
int end,
Match match)
Checks whether the target text contains this pattern
in specified range or not.
|
boolean |
matches(char[] target,
Match match)
Checks whether the target text contains this pattern or not.
|
boolean |
matches(CharacterIterator target)
Checks whether the target text contains this pattern or not.
|
boolean |
matches(CharacterIterator target,
Match match)
Checks whether the target text contains this pattern or not.
|
boolean |
matches(String target)
Checks whether the target text contains this pattern or not.
|
boolean |
matches(String target,
int start,
int end)
Checks whether the target text contains this pattern
in specified range or not.
|
boolean |
matches(String target,
int start,
int end,
Match match)
Checks whether the target text contains this pattern
in specified range or not.
|
boolean |
matches(String target,
Match match)
Checks whether the target text contains this pattern or not.
|
void |
setPattern(String newPattern) |
void |
setPattern(String newPattern,
String options) |
String |
toString()
Represents this instence in String.
|
public RegularExpression(String regex) throws ParseException
regex - A regular expressionorg.apache.xerces.utils.regex.ParseException - regex is not conforming to the syntax.ParseExceptionpublic RegularExpression(String regex, String options) throws ParseException
regex - A regular expressionoptions - A String consisted of "i" "m" "s" "u" "w" "," "X"org.apache.xerces.utils.regex.ParseException - regex is not conforming to the syntax.ParseExceptionpublic boolean matches(char[] target)
public boolean matches(char[] target,
int start,
int end)
start - Start offset of the range.end - End offset +1 of the range.public boolean matches(char[] target,
Match match)
match - A Match instance for storing matching result.public boolean matches(char[] target,
int start,
int end,
Match match)
start - Start offset of the range.end - End offset +1 of the range.match - A Match instance for storing matching result.public boolean matches(String target)
public boolean matches(String target, int start, int end)
start - Start offset of the range.end - End offset +1 of the range.public boolean matches(String target, Match match)
match - A Match instance for storing matching result.public boolean matches(String target, int start, int end, Match match)
start - Start offset of the range.end - End offset +1 of the range.match - A Match instance for storing matching result.public boolean matches(CharacterIterator target)
public boolean matches(CharacterIterator target, Match match)
match - A Match instance for storing matching result.public void setPattern(String newPattern) throws ParseException
ParseExceptionpublic void setPattern(String newPattern, String options) throws ParseException
ParseExceptionpublic String getPattern()
public String toString()
public String getOptions()
setPattern().public boolean equals(Object obj)
public int getNumberOfGroups()