Source for java.util.regex.MatchResult

   1: /* MatchResult.java -- Result of a regular expression match.
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.util.regex;
  40: 
  41: /**
  42:  * This interface represents the result of a regular expression match.
  43:  * It can be used to query the contents of the match, but not to modify
  44:  * them.
  45:  * @since 1.5
  46:  */
  47: public interface MatchResult
  48: {
  49:   /** Returns the index just after the last matched character.  */
  50:   int end();
  51:   
  52:   /**
  53:    * Returns the index just after the last matched character of the
  54:    * given sub-match group.
  55:    * @param group the sub-match group
  56:    */ 
  57:   int end(int group);
  58: 
  59:   /** Returns the substring of the input which was matched.  */
  60:   String group();
  61:   
  62:   /** 
  63:    * Returns the substring of the input which was matched by the
  64:    * given sub-match group.
  65:    * @param group the sub-match group
  66:    */
  67:   String group(int group);
  68: 
  69:   /** Returns the number of sub-match groups in the matching pattern.  */  
  70:   int groupCount();
  71: 
  72:   /** Returns the index of the first character of the match.  */
  73:   int start();
  74: 
  75:   /**
  76:    * Returns the index of the first character of the given sub-match
  77:    * group.
  78:    * @param group the sub-match group
  79:    */
  80:   int start(int group);
  81: }