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;
20
21 import java.util.List;
22
23 /**
24 * <p>
25 * A context for various actions like parsing or building.
26 * </p>
27 *
28 * @author Gerrit Hohl (gerrit-hohl@users.sourceforge.net)
29 * @version <b>1.0</b>, 23.04.2016 by Gerrit Hohl
30 */
31 public interface Context {
32
33
34 /**
35 * <p>
36 * Adds a warning to the context.
37 * </p>
38 * <p>
39 * Warnings can inform about unsupported parameters, unsupported values or
40 * combinations of these. The action will resume it's work (best-effort). If
41 * the problems prevents the rest of the action from working correctly an
42 * exception should be thrown.
43 * </p>
44 *
45 * @param warning
46 * The warning.
47 * @throws IllegalArgumentException
48 * If the warning is <code>null</code>.
49 */
50 void addWarning(Warning warning);
51
52
53 /**
54 * <p>
55 * Returns a list of all warnings added to this context.
56 * </p>
57 * <p>
58 * The returned list will be a copy of the internal list. Modifications on
59 * the returned list don't have any effect on the internal list.
60 * </p>
61 *
62 * @return The warnings.
63 */
64 List<Warning> getWarnings();
65
66
67 }