1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 */
24
25 /*
26 * Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
27 */
28
29 package javax.xml.stream;
30
31 import javax.xml.transform.Result;
32
33 /**
34 * Defines an abstract implementation of a factory for
35 * getting XMLEventWriters and XMLStreamWriters.
36 *
37 * The following table defines the standard properties of this specification.
38 * Each property varies in the level of support required by each implementation.
39 * The level of support required is described in the 'Required' column.
40 *
41 * <table border="2" rules="all" cellpadding="4">
42 * <thead>
43 * <tr>
44 * <th align="center" colspan="2">
45 * Configuration parameters
46 * </th>
47 * </tr>
48 * </thead>
49 * <tbody>
50 * <tr>
51 * <th>Property Name</th>
52 * <th>Behavior</th>
53 * <th>Return type</th>
54 * <th>Default Value</th>
55 * <th>Required</th>
56 * </tr>
57 * <tr><td>javax.xml.stream.isRepairingNamespaces</td><td>defaults prefixes on the output side</td><td>Boolean</td><td>False</td><td>Yes</td></tr>
58 * </tbody>
59 * </table>
60 *
61 * <p>The following paragraphs describe the namespace and prefix repair algorithm:</p>
62 *
63 * <p>The property can be set with the following code line:
64 * <code>setProperty("javax.xml.stream.isRepairingNamespaces",new Boolean(true|false));</code></p>
65 *
66 * <p>This property specifies that the writer default namespace prefix declarations.
67 * The default value is false. </p>
68 *
69 * <p>If a writer isRepairingNamespaces it will create a namespace declaration
70 * on the current StartElement for
71 * any attribute that does not
72 * currently have a namespace declaration in scope. If the StartElement
73 * has a uri but no prefix specified a prefix will be assigned, if the prefix
74 * has not been declared in a parent of the current StartElement it will be declared
75 * on the current StartElement. If the defaultNamespace is bound and in scope
76 * and the default namespace matches the URI of the attribute or StartElement
77 * QName no prefix will be assigned.</p>
78 *
79 * <p>If an element or attribute name has a prefix, but is not
80 * bound to any namespace URI, then the prefix will be removed
81 * during serialization.</p>
82 *
83 * <p>If element and/or attribute names in the same start or
84 * empty-element tag are bound to different namespace URIs and
85 * are using the same prefix then the element or the first
86 * occurring attribute retains the original prefix and the
87 * following attributes have their prefixes replaced with a
88 * new prefix that is bound to the namespace URIs of those
89 * attributes. </p>
90 *
91 * <p>If an element or attribute name uses a prefix that is
92 * bound to a different URI than that inherited from the
93 * namespace context of the parent of that element and there
94 * is no namespace declaration in the context of the current
95 * element then such a namespace declaration is added. </p>
96 *
97 * <p>If an element or attribute name is bound to a prefix and
98 * there is a namespace declaration that binds that prefix
99 * to a different URI then that namespace declaration is
100 * either removed if the correct mapping is inherited from
101 * the parent context of that element, or changed to the
102 * namespace URI of the element or attribute using that prefix.</p>
103 *
104 * @version 1.2
105 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
106 * @see XMLInputFactory
107 * @see XMLEventWriter
108 * @see XMLStreamWriter
109 * @since 1.6
110 */
111 public abstract class XMLOutputFactory {
112 /**
113 * Property used to set prefix defaulting on the output side
114 */
115 public static final String IS_REPAIRING_NAMESPACES=
116 "javax.xml.stream.isRepairingNamespaces";
117
118 static final String DEFAULIMPL = "com.sun.xml.internal.stream.XMLOutputFactoryImpl";
119
120 protected XMLOutputFactory(){}
121
122 /**
123 * Create a new instance of the factory.
124 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
125 */
126 public static XMLOutputFactory newInstance()
127 throws FactoryConfigurationError
128 {
129 return (XMLOutputFactory) FactoryFinder.find(XMLOutputFactory.class,
130 "javax.xml.stream.XMLOutputFactory",
131 DEFAULIMPL);
132 }
133
134 /**
135 * <p>Create a new instance of the factory.
136 * </p><p>
137 * This static method creates a new factory instance. This method uses the
138 * following ordered lookup procedure to determine the XMLOutputFactory
139 * implementation class to load:
140 * <ul>
141 * <li>
142 * Use the javax.xml.stream.XMLOutputFactory system property.
143 * </li>
144 * <li>
145 * Use the properties file "lib/stax.properties" in the JRE directory.
146 * This configuration file is in standard java.util.Properties format
147 * and contains the fully qualified name of the implementation class
148 * with the key being the system property defined above.
149 * </li>
150 * <li>
151 * <p>Uses the service-provider loading facilities, defined by the {@link java.util.ServiceLoader} class, to attempt
152 * to locate and load an implementation of the service. In case of multiple providers, the first non-default implementation
153 * shall be instantiated and returned. The default implementation is returned if it is the only one
154 * found by the service loader.</p>
155 * <p>
156 * If a misconfigured provider is encountered and {@link java.util.ServiceConfigurationError} is thrown, the error will be wrapped
157 * in a {@link javax.xml.stream.FactoryConfigurationError}.</p>
158 * </li>
159 * <li>
160 * Platform default XMLOutputFactory instance.
161 * </li>
162 * </ul>
163 *
164 * Once an application has obtained a reference to a XMLOutputFactory it
165 * can use the factory to configure and obtain stream instances.
166 *</p><p>
167 * Note that this is a new method that replaces the deprecated newInstance() method.
168 * No changes in behavior are defined by this replacement method relative to the
169 * deprecated method.
170 *</p>
171 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
172 */
173 public static XMLOutputFactory newFactory()
174 throws FactoryConfigurationError
175 {
176 return (XMLOutputFactory) FactoryFinder.find(XMLOutputFactory.class,
177 "javax.xml.stream.XMLOutputFactory",
178 DEFAULIMPL);
179 }
180
181 /**
182 * Create a new instance of the factory.
183 *
184 * @param factoryId Name of the factory to find, same as
185 * a property name
186 * @param classLoader classLoader to use
187 * @return the factory implementation
188 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
189 *
190 * @deprecated This method has been deprecated because it returns an
191 * instance of XMLInputFactory, which is of the wrong class.
192 * Use the new method {@link #newFactory(java.lang.String,
193 * java.lang.ClassLoader)} instead.
194 */
195 public static XMLInputFactory newInstance(String factoryId,
196 ClassLoader classLoader)
197 throws FactoryConfigurationError {
198 //do not fallback if given classloader can't find the class, throw exception
199 return (XMLInputFactory) FactoryFinder.find(XMLInputFactory.class, factoryId, classLoader, null);
200 }
201
202 /**
203 * Create a new instance of the factory.
204 * If the classLoader argument is null, then the ContextClassLoader is used.
205 *
206 * Note that this is a new method that replaces the deprecated
207 * newInstance(String factoryId, ClassLoader classLoader) method.
208 *
209 * No changes in behavior are defined by this replacement method relative
210 * to the deprecated method.
211 *
212 *
213 * @param factoryId Name of the factory to find, same as
214 * a property name
215 * @param classLoader classLoader to use
216 * @return the factory implementation
217 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded
218 */
219 public static XMLOutputFactory newFactory(String factoryId,
220 ClassLoader classLoader)
221 throws FactoryConfigurationError {
222 //do not fallback if given classloader can't find the class, throw exception
223 return (XMLOutputFactory) FactoryFinder.find(XMLOutputFactory.class, factoryId, classLoader, null);
224 }
225
226 /**
227 * Create a new XMLStreamWriter that writes to a writer
228 * @param stream the writer to write to
229 * @throws XMLStreamException
230 */
231 public abstract XMLStreamWriter createXMLStreamWriter(java.io.Writer stream) throws XMLStreamException;
232
233 /**
234 * Create a new XMLStreamWriter that writes to a stream
235 * @param stream the stream to write to
236 * @throws XMLStreamException
237 */
238 public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream) throws XMLStreamException;
239
240 /**
241 * Create a new XMLStreamWriter that writes to a stream
242 * @param stream the stream to write to
243 * @param encoding the encoding to use
244 * @throws XMLStreamException
245 */
246 public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream,
247 String encoding) throws XMLStreamException;
248
249 /**
250 * Create a new XMLStreamWriter that writes to a JAXP result. This method is optional.
251 * @param result the result to write to
252 * @throws UnsupportedOperationException if this method is not
253 * supported by this XMLOutputFactory
254 * @throws XMLStreamException
255 */
256 public abstract XMLStreamWriter createXMLStreamWriter(Result result) throws XMLStreamException;
257
258
259 /**
260 * Create a new XMLEventWriter that writes to a JAXP result. This method is optional.
261 * @param result the result to write to
262 * @throws UnsupportedOperationException if this method is not
263 * supported by this XMLOutputFactory
264 * @throws XMLStreamException
265 */
266 public abstract XMLEventWriter createXMLEventWriter(Result result) throws XMLStreamException;
267
268 /**
269 * Create a new XMLEventWriter that writes to a stream
270 * @param stream the stream to write to
271 * @throws XMLStreamException
272 */
273 public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream) throws XMLStreamException;
274
275
276
277 /**
278 * Create a new XMLEventWriter that writes to a stream
279 * @param stream the stream to write to
280 * @param encoding the encoding to use
281 * @throws XMLStreamException
282 */
283 public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream,
284 String encoding) throws XMLStreamException;
285
286 /**
287 * Create a new XMLEventWriter that writes to a writer
288 * @param stream the stream to write to
289 * @throws XMLStreamException
290 */
291 public abstract XMLEventWriter createXMLEventWriter(java.io.Writer stream) throws XMLStreamException;
292
293 /**
294 * Allows the user to set specific features/properties on the underlying implementation.
295 * @param name The name of the property
296 * @param value The value of the property
297 * @throws java.lang.IllegalArgumentException if the property is not supported
298 */
299 public abstract void setProperty(java.lang.String name,
300 Object value)
301 throws IllegalArgumentException;
302
303 /**
304 * Get a feature/property on the underlying implementation
305 * @param name The name of the property
306 * @return The value of the property
307 * @throws java.lang.IllegalArgumentException if the property is not supported
308 */
309 public abstract Object getProperty(java.lang.String name)
310 throws IllegalArgumentException;
311
312 /**
313 * Query the set of properties that this factory supports.
314 *
315 * @param name The name of the property (may not be null)
316 * @return true if the property is supported and false otherwise
317 */
318 public abstract boolean isPropertySupported(String name);
319 }