1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.util;
import org.w3c.dom.CDATASection;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
// CheckStyle:HideUtilityClassConstructorCheck OFF - bc
/**
* Some utility methods for common tasks when building DOM trees in memory.
*
* <p>In this documentation <code><a></code> means an {@link
* org.w3c.dom.Element Element} instance with name <code>a</code>.</p>
*
* @since Ant 1.6.3
*/
public class DOMUtils {
/**
* Get a new Document instance,
* @return the document.
* @since Ant 1.6.3
*/
public static Document newDocument() {
return JAXPUtils.getDocumentBuilder().newDocument();
}
/**
* Creates a named Element and appends it to the given element,
* returns it.
*
* <p>This means
* <pre>createChildElement(<a>, "b")</pre>
* creates
* <pre>
* <a>
* <b/>
* </a>
* </pre>
* and returns <code><b></code>.
*
* @param parent element that will receive the new element as child.
* @param name name of the new element.
* @return the new element.
*
* @since Ant 1.6.3
*/
public static Element createChildElement(Element parent, String name) {
Document doc = parent.getOwnerDocument();
Element e = doc.createElement(name);
parent.appendChild(e);
return e;
}
/**
* Adds nested text.
*
* <p>This means
* <pre>appendText(<a>, "b")</pre>
* creates
* <pre>
* <a>b</a>
* </pre>
*
* @param parent element that will receive the new element as child.
* @param content text content.
*
* @since Ant 1.6.3
*/
public static void appendText(Element parent, String content) {
Document doc = parent.getOwnerDocument();
Text t = doc.createTextNode(content);
parent.appendChild(t);
}
/**
* Adds a nested CDATA section.
*
* <p>This means
* <pre>appendCDATA(<a>, "b")</pre>
* creates
* <pre>
* <a><[!CDATA[b]]></a>
* </pre>
*
* @param parent element that will receive the new element as child.
* @param content text content.
*
* @since Ant 1.6.3
*/
public static void appendCDATA(Element parent, String content) {
Document doc = parent.getOwnerDocument();
CDATASection c = doc.createCDATASection(content);
parent.appendChild(c);
}
/**
* Adds nested text in a new child element.
*
* <p>This means
* <pre>appendTextElement(<a>, "b", "c")</pre>
* creates
* <pre>
* <a>
* <b>c</b>
* </a>
* </pre>
*
* @param parent element that will receive the new element as child.
* @param name of the child element.
* @param content text content.
*
* @since Ant 1.6.3
*/
public static void appendTextElement(Element parent, String name,
String content) {
Element e = createChildElement(parent, name);
appendText(e, content);
}
/**
* Adds a nested CDATA section in a new child element.
*
* <p>This means
* <pre>appendCDATAElement(<a>, "b", "c")</pre>
* creates
* <pre>
* <a>
* <b><![CDATA[c]]></b>
* </a>
* </pre>
*
* @param parent element that will receive the new element as child.
* @param name of the child element.
* @param content text content.
*
* @since Ant 1.6.3
*/
public static void appendCDATAElement(Element parent, String name,
String content) {
Element e = createChildElement(parent, name);
appendCDATA(e, content);
}
}
|
