View Javadoc

1   /*
2    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.properties.reports;
17  
18  import java.io.IOException;
19  import java.io.OutputStream;
20  
21  import de.smartics.properties.report.data.PropertyReportItem;
22  
23  /**
24   * Report on a single property.
25   */
26  public final class XmlPropertyItemReport
27  {
28    // ********************************* Fields *********************************
29  
30    // --- constants ------------------------------------------------------------
31  
32    // --- members --------------------------------------------------------------
33  
34    /**
35     * The encoding used to write.
36     */
37    private final String encoding;
38  
39    // ****************************** Initializer *******************************
40  
41    // ****************************** Constructors ******************************
42  
43    /**
44     * Default constructor.
45     *
46     * @param encoding the encoding used to write.
47     */
48    public XmlPropertyItemReport(final String encoding)
49    {
50      this.encoding = encoding;
51    }
52  
53    // ****************************** Inner Classes *****************************
54  
55    // ********************************* Methods ********************************
56  
57    // --- init -----------------------------------------------------------------
58  
59    // --- get&set --------------------------------------------------------------
60  
61    // --- business -------------------------------------------------------------
62  
63    /**
64     * Writes the report to the given output stream.
65     *
66     * @param reportItem the report item to write.
67     * @param output the stream to write to.
68     * @throws NullPointerException if {@code reportItem} or {@code output} is
69     *           <code>null</code>.
70     * @throws IOException on any problem writing to the stream.
71     */
72    public void write(final PropertyReportItem reportItem,
73        final OutputStream output) throws NullPointerException, IOException
74    {
75      final XmlPropertyReporter reporter =
76          new XmlPropertyReporter(encoding, reportItem);
77      reporter.write(output);
78    }
79  
80    // --- object basics --------------------------------------------------------
81  
82  }