Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * Copyright 2003-2004 Sun Microsystems, Inc.  All Rights Reserved.
3
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4
   *
5
   * This code is free software; you can redistribute it and/or modify it
6
   * under the terms of the GNU General Public License version 2 only, as
7
   * published by the Free Software Foundation.  Sun designates this
8
   * particular file as subject to the "Classpath" exception as provided
9
   * by Sun in the LICENSE file that accompanied this code.
10
  *
11
  * This code is distributed in the hope that it will be useful, but WITHOUT
12
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14
  * version 2 for more details (a copy is included in the LICENSE file that
15
  * accompanied this code).
16
  *
17
  * You should have received a copy of the GNU General Public License version
18
  * 2 along with this work; if not, write to the Free Software Foundation,
19
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20
  *
21
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22
  * CA 95054 USA or visit www.sun.com if you need additional information or
23
  * have any questions.
24
  */
25
 
26
 package java.util.regex;

The result of a match operation.

This interface contains query methods used to determine the results of a match against a regular expression. The match boundaries, groups and group boundaries can be seen but not modified through a MatchResult.

Author(s):
Michael McCloskey
Since:
1.5
See also:
Matcher
39
 
40
 public interface MatchResult {

    
Returns the start index of the match.

Returns:
The index of the first character matched
Throws:
java.lang.IllegalStateException If no match has yet been attempted, or if the previous match operation failed
50
 
51
     public int start();

    
Returns the start index of the subsequence captured by the given group during this match.

Capturing groups are indexed from left to right, starting at one. Group zero denotes the entire pattern, so the expression m.start(0) is equivalent to m.start().

Parameters:
group The index of a capturing group in this matcher's pattern
Returns:
The index of the first character captured by the group, or -1 if the match was successful but the group itself did not match anything
Throws:
java.lang.IllegalStateException If no match has yet been attempted, or if the previous match operation failed
java.lang.IndexOutOfBoundsException If there is no capturing group in the pattern with the given index
76
 
77
     public int start(int group);

    
Returns the offset after the last character matched.

Returns:
The offset after the last character matched
Throws:
java.lang.IllegalStateException If no match has yet been attempted, or if the previous match operation failed
87
 
88
     public int end();

    
Returns the offset after the last character of the subsequence captured by the given group during this match.

Capturing groups are indexed from left to right, starting at one. Group zero denotes the entire pattern, so the expression m.end(0) is equivalent to m.end().

Parameters:
group The index of a capturing group in this matcher's pattern
Returns:
The offset after the last character captured by the group, or -1 if the match was successful but the group itself did not match anything
Throws:
java.lang.IllegalStateException If no match has yet been attempted, or if the previous match operation failed
java.lang.IndexOutOfBoundsException If there is no capturing group in the pattern with the given index
114
    public int end(int group);

    
Returns the input subsequence matched by the previous match.

For a matcher m with input sequence s, the expressions m.group() and s.substring(m.start(), m.end()) are equivalent.

Note that some patterns, for example a*, match the empty string. This method will return the empty string when the pattern successfully matches the empty string in the input.

Returns:
The (possibly empty) subsequence matched by the previous match, in string form
Throws:
java.lang.IllegalStateException If no match has yet been attempted, or if the previous match operation failed
135
    public String group();

    
Returns the input subsequence captured by the given group during the previous match operation.

For a matcher m, input sequence s, and group index g, the expressions m.group(g) and s.substring(m.start(g), m.end(g)) are equivalent.

Capturing groups are indexed from left to right, starting at one. Group zero denotes the entire pattern, so the expression m.group(0) is equivalent to m.group().

If the match was successful but the group specified failed to match any part of the input sequence, then null is returned. Note that some groups, for example (a*), match the empty string. This method will return the empty string when such a group successfully matches the empty string in the input.

Parameters:
group The index of a capturing group in this matcher's pattern
Returns:
The (possibly empty) subsequence captured by the group during the previous match, or null if the group failed to match part of the input
Throws:
java.lang.IllegalStateException If no match has yet been attempted, or if the previous match operation failed
java.lang.IndexOutOfBoundsException If there is no capturing group in the pattern with the given index
172
    public String group(int group);

    
Returns the number of capturing groups in this match result's pattern.

Group zero denotes the entire pattern by convention. It is not included in this count.

Any non-negative integer smaller than or equal to the value returned by this method is guaranteed to be a valid group index for this matcher.

Returns:
The number of capturing groups in this matcher's pattern
186
    public int groupCount();
New to GrepCode? Check out our FAQ X