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 * Same as {@link #newFactory()}. 125 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded 126 */ 127 public static XMLOutputFactory newInstance() 128 throws FactoryConfigurationError 129 { 130 return FactoryFinder.find(XMLOutputFactory.class, DEFAULIMPL); 131 } 132 133 /** 134 * Create a new instance of the factory. 135 * <p> 136 * This static method creates a new factory instance. This method uses the 137 * following ordered lookup procedure to determine the XMLOutputFactory 138 * implementation class to load: 139 * </p> 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 * if present, otherwise, use the properties file "lib/jaxp.properties" 147 * in the JRE directory. 148 * These configuration files are in standard java.util.Properties format 149 * and contain the fully qualified name of the implementation class 150 * with the key being the system property defined above. 151 * </li> 152 * <li> 153 * Use the service-provider loading facilities, defined by the 154 * {@link java.util.ServiceLoader} class, to attempt to locate and load an 155 * implementation of the service. 156 * </li> 157 * <li> 158 * Otherwise, the system-default implementation is returned. 159 * </li> 160 * <p> 161 * Once an application has obtained a reference to a XMLOutputFactory it 162 * can use the factory to configure and obtain stream instances. 163 * </p> 164 * <p> 165 * Note that this is a new method that replaces the deprecated newInstance() method. 166 * No changes in behavior are defined by this replacement method relative to the 167 * deprecated method. 168 * </p> 169 * @throws FactoryConfigurationError in case of {@linkplain 170 * java.util.ServiceConfigurationError service configuration error} or if 171 * the implementation is not available or cannot be instantiated. 172 */ 173 public static XMLOutputFactory newFactory() 174 throws FactoryConfigurationError 175 { 176 return FactoryFinder.find(XMLOutputFactory.class, DEFAULIMPL); 177 } 178 179 /** 180 * Create a new instance of the factory. 181 * 182 * @param factoryId Name of the factory to find, same as 183 * a property name 184 * @param classLoader classLoader to use 185 * @return the factory implementation 186 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded 187 * 188 * @deprecated This method has been deprecated because it returns an 189 * instance of XMLInputFactory, which is of the wrong class. 190 * Use the new method {@link #newFactory(java.lang.String, 191 * java.lang.ClassLoader)} instead. 192 */ 193 public static XMLInputFactory newInstance(String factoryId, 194 ClassLoader classLoader) 195 throws FactoryConfigurationError { 196 //do not fallback if given classloader can't find the class, throw exception 197 return FactoryFinder.find(XMLInputFactory.class, factoryId, classLoader, null); 198 } 199 200 /** 201 * Create a new instance of the factory. 202 * If the classLoader argument is null, then the ContextClassLoader is used. 203 * <p> 204 * This method uses the following ordered lookup procedure to determine 205 * the XMLOutputFactory implementation class to load: 206 * </p> 207 * <ul> 208 * <li> 209 * Use the value of the system property identified by {@code factoryId}. 210 * </li> 211 * <li> 212 * Use the properties file "lib/stax.properties" in the JRE directory, 213 * if present, otherwise, use the properties file "lib/jaxp.properties" 214 * in the JRE directory. 215 * These configuration files are in standard java.util.Properties format 216 * and contain the fully qualified name of the implementation class 217 * with the key being the given {@code factoryId}. 218 * </li> 219 * <li> 220 * If {@code factoryId} is the base service class name, 221 * use the service-provider loading facilities, defined by the 222 * {@link java.util.ServiceLoader} class, to attempt to locate and load an 223 * implementation of the service. 224 * </li> 225 * <li> 226 * Otherwise, throws a {@link FactoryConfigurationError}. 227 * </li> 228 * </ul> 229 * 230 * <p> 231 * Note that this is a new method that replaces the deprecated 232 * {@link #newInstance(java.lang.String, java.lang.ClassLoader) 233 * newInstance(String factoryId, ClassLoader classLoader)} method. 234 * No changes in behavior are defined by this replacement method relative 235 * to the deprecated method. 236 * </p> 237 * 238 * @param factoryId Name of the factory to find, same as 239 * a property name 240 * @param classLoader classLoader to use 241 * @return the factory implementation 242 * @throws FactoryConfigurationError in case of {@linkplain 243 * java.util.ServiceConfigurationError service configuration error} or if 244 * the implementation is not available or cannot be instantiated. 245 */ 246 public static XMLOutputFactory newFactory(String factoryId, 247 ClassLoader classLoader) 248 throws FactoryConfigurationError { 249 //do not fallback if given classloader can't find the class, throw exception 250 return FactoryFinder.find(XMLOutputFactory.class, factoryId, classLoader, null); 251 } 252 253 /** 254 * Create a new XMLStreamWriter that writes to a writer 255 * @param stream the writer to write to 256 * @throws XMLStreamException 257 */ 258 public abstract XMLStreamWriter createXMLStreamWriter(java.io.Writer stream) throws XMLStreamException; 259 260 /** 261 * Create a new XMLStreamWriter that writes to a stream 262 * @param stream the stream to write to 263 * @throws XMLStreamException 264 */ 265 public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream) throws XMLStreamException; 266 267 /** 268 * Create a new XMLStreamWriter that writes to a stream 269 * @param stream the stream to write to 270 * @param encoding the encoding to use 271 * @throws XMLStreamException 272 */ 273 public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream, 274 String encoding) throws XMLStreamException; 275 276 /** 277 * Create a new XMLStreamWriter that writes to a JAXP result. This method is optional. 278 * @param result the result to write to 279 * @throws UnsupportedOperationException if this method is not 280 * supported by this XMLOutputFactory 281 * @throws XMLStreamException 282 */ 283 public abstract XMLStreamWriter createXMLStreamWriter(Result result) throws XMLStreamException; 284 285 286 /** 287 * Create a new XMLEventWriter that writes to a JAXP result. This method is optional. 288 * @param result the result to write to 289 * @throws UnsupportedOperationException if this method is not 290 * supported by this XMLOutputFactory 291 * @throws XMLStreamException 292 */ 293 public abstract XMLEventWriter createXMLEventWriter(Result result) throws XMLStreamException; 294 295 /** 296 * Create a new XMLEventWriter that writes to a stream 297 * @param stream the stream to write to 298 * @throws XMLStreamException 299 */ 300 public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream) throws XMLStreamException; 301 302 303 304 /** 305 * Create a new XMLEventWriter that writes to a stream 306 * @param stream the stream to write to 307 * @param encoding the encoding to use 308 * @throws XMLStreamException 309 */ 310 public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream, 311 String encoding) throws XMLStreamException; 312 313 /** 314 * Create a new XMLEventWriter that writes to a writer 315 * @param stream the stream to write to 316 * @throws XMLStreamException 317 */ 318 public abstract XMLEventWriter createXMLEventWriter(java.io.Writer stream) throws XMLStreamException; 319 320 /** 321 * Allows the user to set specific features/properties on the underlying implementation. 322 * @param name The name of the property 323 * @param value The value of the property 324 * @throws java.lang.IllegalArgumentException if the property is not supported 325 */ 326 public abstract void setProperty(java.lang.String name, 327 Object value) 328 throws IllegalArgumentException; 329 330 /** 331 * Get a feature/property on the underlying implementation 332 * @param name The name of the property 333 * @return The value of the property 334 * @throws java.lang.IllegalArgumentException if the property is not supported 335 */ 336 public abstract Object getProperty(java.lang.String name) 337 throws IllegalArgumentException; 338 339 /** 340 * Query the set of properties that this factory supports. 341 * 342 * @param name The name of the property (may not be null) 343 * @return true if the property is supported and false otherwise 344 */ 345 public abstract boolean isPropertySupported(String name); 346 }