001 /* MatchResult.java -- Result of a regular expression match.
002 Copyright (C) 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.util.regex;
040
041 /**
042 * This interface represents the result of a regular expression match.
043 * It can be used to query the contents of the match, but not to modify
044 * them.
045 * @since 1.5
046 */
047 public interface MatchResult
048 {
049 /** Returns the index just after the last matched character. */
050 int end();
051
052 /**
053 * Returns the index just after the last matched character of the
054 * given sub-match group.
055 * @param group the sub-match group
056 */
057 int end(int group);
058
059 /** Returns the substring of the input which was matched. */
060 String group();
061
062 /**
063 * Returns the substring of the input which was matched by the
064 * given sub-match group.
065 * @param group the sub-match group
066 */
067 String group(int group);
068
069 /** Returns the number of sub-match groups in the matching pattern. */
070 int groupCount();
071
072 /** Returns the index of the first character of the match. */
073 int start();
074
075 /**
076 * Returns the index of the first character of the given sub-match
077 * group.
078 * @param group the sub-match group
079 */
080 int start(int group);
081 }