Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
Configurator | 35 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software 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 GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.rendering.internal.macro.chart.source; | |
21 | ||
22 | import org.xwiki.rendering.macro.MacroExecutionException; | |
23 | ||
24 | /** | |
25 | * Configurator interface. | |
26 | * | |
27 | * Currently, the parameter handling in the Chart macro is a mess, whith most things thrown into the generic "param" | |
28 | * parameter. The configurator interface is used by classes that use the macro parameters for configuration. | |
29 | * | |
30 | * All parameters will be set by calling setParameter in all configurators before the validation is performed. | |
31 | * | |
32 | * @version $Id: d0a42b11947429dd0147c960799e2178b648b3c5 $ | |
33 | * @since 4.2M1 | |
34 | */ | |
35 | public interface Configurator | |
36 | { | |
37 | /** | |
38 | * Let an implementation set a parameter. | |
39 | * | |
40 | * @param key The key of the parameter. | |
41 | * @param value The value of the parameter. | |
42 | * @return {@code true} if the parameter was claimed. | |
43 | * @throws MacroExecutionException if the parameter is not supported by the data source. | |
44 | */ | |
45 | boolean setParameter(String key, String value) throws MacroExecutionException; | |
46 | ||
47 | /** | |
48 | * Let an implementation validate the value of the previously set parameters, and set default values. | |
49 | * | |
50 | * @throws MacroExecutionException if the previously set value is invalid. | |
51 | */ | |
52 | void validateParameters() throws MacroExecutionException; | |
53 | } |