1 /*
   2  * Copyright (c) 2010, 2013, Oracle and/or its affiliates. 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.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.nashorn.internal.runtime.regexp;
  27 
  28 import java.util.regex.MatchResult;
  29 
  30 /**
  31  * Interface for matching a regular expression against a string and retrieving the
  32  * match result. Extends {@link MatchResult}.
  33  */
  34 public interface RegExpMatcher extends MatchResult {
  35 
  36     /**
  37      * Searches for pattern starting at {@code start}. Returns {@code true} if a match was found.
  38      *
  39      * @param start the start index in the input string
  40      * @return {@code true} if a match was found
  41      */
  42     boolean search(int start);
  43 
  44     /**
  45      * Get the input string.
  46      *
  47      * @return the input string
  48      */
  49     String getInput();
  50 
  51 }