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("javax.xml.stream.XMLOutputFactory", 130 DEFAULIMPL); 131 } 132 133 /** 134 * Create a new instance of the factory. 135 * This static method creates a new factory instance. This method uses the 136 * following ordered lookup procedure to determine the XMLOutputFactory 137 * implementation class to load: 138 * Use the javax.xml.stream.XMLOutputFactory system property. 139 * Use the properties file "lib/stax.properties" in the JRE directory. 140 * This configuration file is in standard java.util.Properties format 141 * and contains the fully qualified name of the implementation class 142 * with the key being the system property defined above. 143 * Use the Services API (as detailed in the JAR specification), if available, 144 * to determine the classname. The Services API will look for a classname 145 * in the file META-INF/services/javax.xml.stream.XMLOutputFactory in jars 146 * available to the runtime. 147 * Platform default XMLOutputFactory instance. 148 * 149 * Once an application has obtained a reference to a XMLOutputFactory it 150 * can use the factory to configure and obtain stream instances. 151 * 152 * Note that this is a new method that replaces the deprecated newInstance() method. 153 * No changes in behavior are defined by this replacement method relative to the 154 * deprecated method. 155 * 156 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded 157 */ 158 public static XMLOutputFactory newFactory() 159 throws FactoryConfigurationError 160 { 161 return (XMLOutputFactory) FactoryFinder.find("javax.xml.stream.XMLOutputFactory", 162 DEFAULIMPL); 163 } 164 165 /** 166 * Create a new instance of the factory. 167 * 168 * @param factoryId Name of the factory to find, same as 169 * a property name 170 * @param classLoader classLoader to use 171 * @return the factory implementation 172 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded 173 * 174 * @deprecated This method has been deprecated because it returns an 175 * instance of XMLInputFactory, which is of the wrong class. 176 * Use the new method {@link #newFactory(java.lang.String, 177 * java.lang.ClassLoader)} instead. 178 */ 179 public static XMLInputFactory newInstance(String factoryId, 180 ClassLoader classLoader) 181 throws FactoryConfigurationError { 182 try { 183 //do not fallback if given classloader can't find the class, throw exception 184 return (XMLInputFactory) FactoryFinder.find(factoryId, classLoader, null); 185 } catch (FactoryFinder.ConfigurationError e) { 186 throw new FactoryConfigurationError(e.getException(), 187 e.getMessage()); 188 } 189 } 190 191 /** 192 * Create a new instance of the factory. 193 * If the classLoader argument is null, then the ContextClassLoader is used. 194 * 195 * Note that this is a new method that replaces the deprecated 196 * newInstance(String factoryId, ClassLoader classLoader) method. 197 * 198 * No changes in behavior are defined by this replacement method relative 199 * to the deprecated method. 200 * 201 * 202 * @param factoryId Name of the factory to find, same as 203 * a property name 204 * @param classLoader classLoader to use 205 * @return the factory implementation 206 * @throws FactoryConfigurationError if an instance of this factory cannot be loaded 207 */ 208 public static XMLOutputFactory newFactory(String factoryId, 209 ClassLoader classLoader) 210 throws FactoryConfigurationError { 211 try { 212 //do not fallback if given classloader can't find the class, throw exception 213 return (XMLOutputFactory) FactoryFinder.find(factoryId, classLoader, null); 214 } catch (FactoryFinder.ConfigurationError e) { 215 throw new FactoryConfigurationError(e.getException(), 216 e.getMessage()); 217 } 218 } 219 220 /** 221 * Create a new XMLStreamWriter that writes to a writer 222 * @param stream the writer to write to 223 * @throws XMLStreamException 224 */ 225 public abstract XMLStreamWriter createXMLStreamWriter(java.io.Writer stream) throws XMLStreamException; 226 227 /** 228 * Create a new XMLStreamWriter that writes to a stream 229 * @param stream the stream to write to 230 * @throws XMLStreamException 231 */ 232 public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream) throws XMLStreamException; 233 234 /** 235 * Create a new XMLStreamWriter that writes to a stream 236 * @param stream the stream to write to 237 * @param encoding the encoding to use 238 * @throws XMLStreamException 239 */ 240 public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream, 241 String encoding) throws XMLStreamException; 242 243 /** 244 * Create a new XMLStreamWriter that writes to a JAXP result. This method is optional. 245 * @param result the result to write to 246 * @throws UnsupportedOperationException if this method is not 247 * supported by this XMLOutputFactory 248 * @throws XMLStreamException 249 */ 250 public abstract XMLStreamWriter createXMLStreamWriter(Result result) throws XMLStreamException; 251 252 253 /** 254 * Create a new XMLEventWriter that writes to a JAXP result. This method is optional. 255 * @param result the result to write to 256 * @throws UnsupportedOperationException if this method is not 257 * supported by this XMLOutputFactory 258 * @throws XMLStreamException 259 */ 260 public abstract XMLEventWriter createXMLEventWriter(Result result) throws XMLStreamException; 261 262 /** 263 * Create a new XMLEventWriter that writes to a stream 264 * @param stream the stream to write to 265 * @throws XMLStreamException 266 */ 267 public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream) throws XMLStreamException; 268 269 270 271 /** 272 * Create a new XMLEventWriter that writes to a stream 273 * @param stream the stream to write to 274 * @param encoding the encoding to use 275 * @throws XMLStreamException 276 */ 277 public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream, 278 String encoding) throws XMLStreamException; 279 280 /** 281 * Create a new XMLEventWriter that writes to a writer 282 * @param stream the stream to write to 283 * @throws XMLStreamException 284 */ 285 public abstract XMLEventWriter createXMLEventWriter(java.io.Writer stream) throws XMLStreamException; 286 287 /** 288 * Allows the user to set specific features/properties on the underlying implementation. 289 * @param name The name of the property 290 * @param value The value of the property 291 * @throws java.lang.IllegalArgumentException if the property is not supported 292 */ 293 public abstract void setProperty(java.lang.String name, 294 Object value) 295 throws IllegalArgumentException; 296 297 /** 298 * Get a feature/property on the underlying implementation 299 * @param name The name of the property 300 * @return The value of the property 301 * @throws java.lang.IllegalArgumentException if the property is not supported 302 */ 303 public abstract Object getProperty(java.lang.String name) 304 throws IllegalArgumentException; 305 306 /** 307 * Query the set of properties that this factory supports. 308 * 309 * @param name The name of the property (may not be null) 310 * @return true if the property is supported and false otherwise 311 */ 312 public abstract boolean isPropertySupported(String name); 313 }