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: Helper.java,v $
37 *
38 * Author: Jose San Leandro Armend?riz
39 *
40 * Description: Represents a regexp helper. Different implementations vary
41 * but they all must respect this set of methods.
42 *
43 * Last modified by: $Author: chous $ at $Date: 2003/06/21 21:07:25 $
44 *
45 * File version: $Revision: 1.1 $
46 *
47 * Project version: $Name: $
48 * ("Name" means no concrete version has been checked out)
49 *
50 * $Id: Helper.java,v 1.1 2003/06/21 21:07:25 chous Exp $
51 *
52 */
53 package org.acmsl.regexpplugin;
54
55 /*
56 * Importing project-specific classes.
57 */
58 import org.acmsl.regexpplugin.MalformedPatternException;
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 helper. Different implementations vary but they all
69 * 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.1 $
73 */
74 public interface Helper
75 extends Versionable
76 {
77 /***
78 * Finds all occurrences of a specified pattern in given input contents,
79 * and replaces them with passed String.
80 * @param input the input text to process.
81 * @param pattern the pattern to replace.
82 * @param replacement the replacement text.
83 * @return the updated input.
84 * @throws MalformedPatternException if given regexp is malformed.
85 */
86 public String replaceAll(String input, String pattern, String replacement)
87 throws MalformedPatternException;
88
89 /***
90 * Concrete version object updated everytime it's checked-in in a CVS
91 * repository.
92 */
93 public static final Version VERSION =
94 VersionFactory.createVersion("$Revision: 1.1 $");
95 }
This page was automatically generated by Maven