Source code: org/acmsl/regexpplugin/Matcher.java
1 /*
2 Java Regular Expressions Plugin API
3
4 Copyright (C) 2002 Jose San Leandro Armendáriz
5 jsanleandro@yahoo.es
6 chousz@yahoo.com
7
8 This library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Lesser General Public
10 License as published by the Free Software Foundation; either
11 version 2.1 of the License, or (at your option) any later version.
12
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public
19 License along with this library; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
22 Thanks to ACM S.L. for distributing this library under the LGPL license.
23 Contact info: jsr000@terra.es
24 Postal Address: c/Playa de Lagoa, 1
25 Urb. Valdecabañas
26 Boadilla del monte
27 28660 Madrid
28 Spain
29
30 This library uses some external APIs. So far I haven't released such
31 APIs as projects themselves, but you should be able
32 to download them from the web page where you got this source code.
33
34 ******************************************************************************
35 *
36 * Filename: $RCSfile: Matcher.java,v $
37 *
38 * Author: Jose San Leandro Armendáriz
39 *
40 * Description: Represents a regexp pattern matcher. Different implementations
41 * vary but they all must respect this set of methods.
42 *
43 * Last modified by: $Author: dev $ at $Date: 2002/09/27 08:27:12 $
44 *
45 * File version: $Revision: 1.5 $
46 *
47 * Project version: $Name: $
48 * ("Name" means no concrete version has been checked out)
49 *
50 * $Id: Matcher.java,v 1.5 2002/09/27 08:27:12 dev Exp $
51 *
52 */
53 package org.acmsl.regexpplugin;
54
55 /*
56 * Importing project-specific classes.
57 */
58 import org.acmsl.regexpplugin.Pattern;
59
60 /*
61 * Importing some ACM classes.
62 */
63 import org.acmsl.version.Version;
64 import org.acmsl.version.Versionable;
65 import org.acmsl.version.VersionFactory;
66
67 /**
68 * Represents a regexp pattern matcher. Different implementations vary but they
69 * all must respect this set of methods.
70 * @author <a href="mailto:jsanleandro@yahoo.es"
71 >Jose San Leandro Armendáriz</a>
72 * @version $Revision: 1.5 $
73 */
74 public interface Matcher
75 extends Versionable
76 {
77 /**
78 * Checks if given text contains specified pattern.
79 * @param text the text to analyze.
80 * @param pattern the regular expression to apply.
81 * @return true if the pattern is found.
82 */
83 public boolean contains(String text, Pattern pattern);
84
85 /**
86 * Retrieves the last match found due to a previous call to
87 * <i>contains</i> method.
88 * @return such match result.
89 */
90 public MatchResult getMatch();
91
92 /**
93 * Concrete version object updated everytime it's checked-in in a CVS
94 * repository.
95 */
96 public static final Version VERSION =
97 VersionFactory.createVersion("$Revision: 1.5 $");
98 }