1 /*
2 * dpkg - Debian Package library and the Debian Package Maven plugin
3 * (c) Copyright 2016 Gerrit Hohl
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 */
19 package net.sourceforge.javadpkg.replace;
20
21 import net.sourceforge.javadpkg.Context;
22
23 /**
24 * <p>
25 * A replacer.
26 * </p>
27 *
28 * @author Gerrit Hohl (gerrit-hohl@users.sourceforge.net)
29 * @version <b>1.0</b>, 02.05.2016 by Gerrit Hohl
30 */
31 public interface Replacer {
32
33
34 /**
35 * <p>
36 * Replaces the variables in the specified line by their values.
37 * </p>
38 *
39 * @param line
40 * The line containing the variables.
41 * @param replacements
42 * The replacements.
43 * @param context
44 * The context.
45 * @return The line containing the values.
46 * @throws IllegalArgumentException
47 * If any of the parameters are <code>null</code>.
48 * @throws ReplacementException
49 * If an error occurs during the replacement.
50 */
51 String replace(String line, Replacements replacements, Context context) throws ReplacementException;
52
53
54 }