1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 */
19 package org.apache.rat.report;
20
21 import org.apache.rat.ReportConfiguration;
22 import org.apache.rat.api.RatException;
23 import org.apache.rat.configuration.XMLConfigurationWriter;
24 import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
25 import org.apache.rat.report.xml.writer.IXmlWriter;
26
27 /**
28 * A report that dumps the ReportConfiguration into the XML output.
29 */
30 public class ConfigurationReport implements RatReport {
31 /** The report configuration to report on. */
32 private final ReportConfiguration configuration;
33 /** The XML writer to write the report with. */
34 private final IXmlWriter writer;
35
36 /**
37 * Constructor.
38 *
39 * @param writer The writer to write the XML data to.
40 * @param configuration the configuration to dump
41 */
42 public ConfigurationReport(final IXmlWriter writer, final ReportConfiguration configuration) {
43 this.configuration = configuration;
44 this.writer = writer;
45 }
46
47 @Override
48 public void startReport() throws RatException {
49 if (configuration.listFamilies() != LicenseFilter.NONE || configuration.listLicenses() != LicenseFilter.NONE) {
50 new XMLConfigurationWriter(configuration).write(writer);
51 }
52 }
53 }