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
22 /**
23 * <p>
24 * Offers the values for variables which should be replaced.
25 * </p>
26 *
27 * @author Gerrit Hohl (gerrit-hohl@users.sourceforge.net)
28 * @version <b>1.0</b>, 04.05.2016 by Gerrit Hohl
29 */
30 public interface Replacements {
31
32
33 /**
34 * <p>
35 * Returns the value for the variable with the specified name.
36 * </p>
37 *
38 * @param name
39 * The name.
40 * @return The value or <code>null</code>, if the variable is unknown.
41 * @throws IllegalArgumentException
42 * If the name is <code>null</code>.
43 * @throws ReplacementException
44 * If an error occurs while determine the value.
45 */
46 String getValue(String name) throws ReplacementException;
47
48
49 }