blob: 4635084c5a7b3abb94310c55459ccefab35fa516 (
plain)
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/*
* Copyright 2002-2004 Apache Software Foundation
*
* Licensed 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 java.io.File;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.FactoryConfigurationError;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.apache.tools.ant.BuildException;
import org.xml.sax.Parser;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
/**
* Collection of helper methods that retrieve a ParserFactory or
* Parsers and Readers.
*
* <p>This class will create only a single factory instance.</p>
*
* @author Stefan Bodewig
*
* @since Ant 1.5
*/
public class JAXPUtils {
/**
* Helper for systemId.
*
* @since Ant 1.6
*/
private static final FileUtils fu = FileUtils.newFileUtils();
/**
* Parser factory to use to create parsers.
* @see #getParserFactory
*
* @since Ant 1.5
*/
private static SAXParserFactory parserFactory = null;
/**
* Parser Factory to create Namespace aware parsers.
*
* @since Ant 1.6
*/
private static SAXParserFactory nsParserFactory = null;
/**
* Parser factory to use to create document builders.
*
* @since Ant 1.6
*/
private static DocumentBuilderFactory builderFactory = null;
/**
* Returns the parser factory to use. Only one parser factory is
* ever created by this method and is then cached for future use.
*
* @return a SAXParserFactory to use
*
* @since Ant 1.5
*/
public static synchronized SAXParserFactory getParserFactory()
throws BuildException {
if (parserFactory == null) {
parserFactory = newParserFactory();
}
return parserFactory;
}
/**
* Returns the parser factory to use to create namespace aware parsers.
*
* @return a SAXParserFactory to use which supports manufacture of
* namespace aware parsers
*
* @since Ant 1.6
*/
public static synchronized SAXParserFactory getNSParserFactory()
throws BuildException {
if (nsParserFactory == null) {
nsParserFactory = newParserFactory();
nsParserFactory.setNamespaceAware(true);
}
return nsParserFactory;
}
/**
* Returns a new parser factory instance.
*
* @since Ant 1.5
*/
public static SAXParserFactory newParserFactory() throws BuildException {
try {
return SAXParserFactory.newInstance();
} catch (FactoryConfigurationError e) {
throw new BuildException("XML parser factory has not been "
+ "configured correctly: "
+ e.getMessage(), e);
}
}
/**
* Returns a newly created SAX 1 Parser, using the default parser
* factory.
*
* @return a SAX 1 Parser.
* @see #getParserFactory
* @since Ant 1.5
*/
public static Parser getParser() throws BuildException {
try {
return newSAXParser(getParserFactory()).getParser();
} catch (SAXException e) {
throw convertToBuildException(e);
}
}
/**
* Returns a newly created SAX 2 XMLReader, using the default parser
* factory.
*
* @return a SAX 2 XMLReader.
* @see #getParserFactory
* @since Ant 1.5
*/
public static XMLReader getXMLReader() throws BuildException {
try {
return newSAXParser(getParserFactory()).getXMLReader();
} catch (SAXException e) {
throw convertToBuildException(e);
}
}
/**
* Returns a newly created SAX 2 XMLReader, which is namespace aware
*
* @return a SAX 2 XMLReader.
* @see #getParserFactory
* @since Ant 1.6
*/
public static XMLReader getNamespaceXMLReader() throws BuildException {
try {
return newSAXParser(getNSParserFactory()).getXMLReader();
} catch (SAXException e) {
throw convertToBuildException(e);
}
}
/**
* This is a best attempt to provide a URL.toExternalForm() from
* a file URL. Some parsers like Crimson choke on uri that are made of
* backslashed paths (ie windows) as it is does not conform
* URI specifications.
* @param file the file to create the system id from.
* @return the systemid corresponding to the given file.
* @since Ant 1.5.2
*/
public static String getSystemId(File file) {
return fu.toURI(file.getAbsolutePath());
}
/**
* Returns a newly created DocumentBuilder.
*
* @return a DocumentBuilder
* @since Ant 1.6
*/
public static DocumentBuilder getDocumentBuilder() throws BuildException {
try {
return getDocumentBuilderFactory().newDocumentBuilder();
} catch (ParserConfigurationException e) {
throw new BuildException(e);
}
}
/**
* @return a new SAXParser instance as helper for getParser and
* getXMLReader.
*
* @since Ant 1.5
*/
private static SAXParser newSAXParser(SAXParserFactory factory)
throws BuildException {
try {
return factory.newSAXParser();
} catch (ParserConfigurationException e) {
throw new BuildException("Cannot create parser for the given "
+ "configuration: " + e.getMessage(), e);
} catch (SAXException e) {
throw convertToBuildException(e);
}
}
/**
* Translate a SAXException into a BuildException
*
* @since Ant 1.5
*/
private static BuildException convertToBuildException(SAXException e) {
Exception nested = e.getException();
if (nested != null) {
return new BuildException(nested);
} else {
return new BuildException(e);
}
}
/**
* Obtains the default builder factory if not already.
*
* @since Ant 1.6
*/
private static synchronized
DocumentBuilderFactory getDocumentBuilderFactory()
throws BuildException {
if (builderFactory == null) {
try {
builderFactory = DocumentBuilderFactory.newInstance();
} catch (FactoryConfigurationError e) {
throw new BuildException("Document builder factory has not "
+ "been configured correctly: "
+ e.getMessage(), e);
}
}
return builderFactory;
}
}
|