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.plugin;
20
21 import java.io.IOException;
22
23 import org.apache.maven.plugin.logging.Log;
24
25 import net.sourceforge.javadpkg.Context;
26 import net.sourceforge.javadpkg.Copyright;
27 import net.sourceforge.javadpkg.ParseException;
28 import net.sourceforge.javadpkg.plugin.cfg.CopyrightConfiguration;
29
30 /**
31 * <p>
32 * A parser for the copyright configuration.
33 * </p>
34 *
35 * @author Gerrit Hohl (gerrit-hohl@users.sourceforge.net)
36 * @version <b>1.0</b>, 09.05.2016 by Gerrit Hohl
37 */
38 public interface CopyrightConfigurationParser {
39
40
41 /**
42 * <p>
43 * Parses the copyright from the specified configuration.
44 * </p>
45 *
46 * @param log
47 * The log.
48 * @param config
49 * The configuration.
50 * @return The copyright.
51 * @param context
52 * The context.
53 * @throws IllegalArgumentException
54 * If any of the parameters are <code>null</code>.
55 * @throws IOException
56 * If an I/O error occurs.
57 * @throws ParseException
58 * If an error occurs during the parsing.
59 */
60 Copyright parseCopyrightConfiguration(Log log, CopyrightConfiguration config, Context context)
61 throws IOException, ParseException;
62
63
64 }