1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 or later
5    * as published by the Free Software Foundation. This program is distributed
6    * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
7    * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *      http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * © CrossWire Bible Society, 2007 - 2016
18   *
19   */
20  package org.crosswire.common.diff;
21  
22  /**
23   * Represents the location of the best match.
24   * 
25   * @see gnu.lgpl.License The GNU Lesser General Public License for details.
26   * @author DM Smith
27   */
28  public interface Locator {
29      /**
30       * Locate the best match of a pattern in text near a supplied location.
31       * 
32       * @return Best match index or -1, if no match found
33       */
34      int locate();
35  
36      /**
37       * The maximum length a pattern can be.
38       * 
39       * @return maximum pattern length.
40       */
41      int maxPatternLength();
42  }
43