1 /*
2 * Copyright 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.config.transfer.templatestream;
17
18 import org.apache.commons.lang.StringEscapeUtils;
19
20 /**
21 * Creates instances of {@link StreamPropertySink} by providing a template to
22 * generate an XML document.
23 */
24 public class XmlFactory extends Factory
25 {
26 // ********************************* Fields *********************************
27
28 // --- constants ------------------------------------------------------------
29
30 // --- members --------------------------------------------------------------
31
32 // ****************************** Initializer *******************************
33
34 // ****************************** Constructors ******************************
35
36 /**
37 * Default constructor.
38 */
39 public XmlFactory()
40 {
41 setLineIntro(" <properties from=\"${location}\">${newline}");
42 setLineExtro(" </properties>${newline}");
43 setEscaper(new ValueEscaper()
44 {
45 @Override
46 public String escape(final String value)
47 {
48 return StringEscapeUtils.escapeXml(value);
49 }
50 });
51
52 final String template =
53 " <property config=\"${configKey}\" name=\"${name}\">${value}</property>${newline}";
54 setTemplate(template);
55 }
56
57 // ****************************** Inner Classes *****************************
58
59 // ********************************* Methods ********************************
60
61 // --- init -----------------------------------------------------------------
62
63 // --- get&set --------------------------------------------------------------
64
65 // --- business -------------------------------------------------------------
66
67 /**
68 * {@inheritDoc}
69 *
70 * @throws IllegalStateException on any problem opening the stream.
71 */
72 @Override
73 public StreamPropertySink create() throws IllegalStateException
74 {
75 setDocumentIntro("<?xml version=\"1.0\" encoding=\"" + getEncoding()
76 + "\"?>${newline}${newline}" + "<config>${newline}");
77 setDocumentExtro("</config>${newline}");
78
79 return super.create();
80 }
81
82 // --- object basics --------------------------------------------------------
83
84 }