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.control;
20
21 import net.sourceforge.javadpkg.BuildException;
22 import net.sourceforge.javadpkg.Context;
23
24 /**
25 * <p>
26 * A builder for the description of a package.
27 * </p>
28 *
29 * @author Gerrit Hohl (gerrit-hohl@users.sourceforge.net)
30 * @version <b>1.0</b>, 28.04.2016 by Gerrit Hohl
31 */
32 public interface DescriptionBuilder {
33
34
35 /**
36 * <p>
37 * Builds a description of a package.
38 * </p>
39 *
40 * @param description
41 * The package description.
42 * @param context
43 * The context.
44 * @return The value.
45 * @throws IllegalArgumentException
46 * If any of the parameters are <code>null</code>.
47 * @throws BuildException
48 * If an error occurs during the building.
49 */
50 String buildDescription(Description description, Context context) throws BuildException;
51
52
53 }