1 /* 2 * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package javax.xml.transform; 27 28 import java.util.Properties; 29 30 31 32 33 /** 34 * An object that implements this interface is the runtime representation of processed 35 * transformation instructions. 36 * 37 * <p>Templates must be threadsafe for a given instance 38 * over multiple threads running concurrently, and may 39 * be used multiple times in a given session.</p> 40 * 41 * @since 1.4 42 */ 43 public interface Templates { 44 45 /** 46 * Create a new transformation context for this Templates object. 47 * 48 * @return A valid non-null instance of a Transformer. 49 * 50 * @throws TransformerConfigurationException if a Transformer can not be created. 51 */ newTransformer()52 Transformer newTransformer() throws TransformerConfigurationException; 53 54 /** 55 * Get the properties corresponding to the effective xsl:output element. 56 * The object returned will 57 * be a clone of the internal values. Accordingly, it can be mutated 58 * without mutating the Templates object, and then handed in to 59 * {@link javax.xml.transform.Transformer#setOutputProperties}. 60 * 61 * <p>The properties returned should contain properties set by the stylesheet, 62 * and these properties are "defaulted" by default properties specified by 63 * <a href="http://www.w3.org/TR/xslt#output">section 16 of the 64 * XSL Transformations (XSLT) W3C Recommendation</a>. The properties that 65 * were specifically set by the stylesheet should be in the base 66 * Properties list, while the XSLT default properties that were not 67 * specifically set should be in the "default" Properties list. Thus, 68 * getOutputProperties().getProperty(String key) will obtain any 69 * property in that was set by the stylesheet, <em>or</em> the default 70 * properties, while 71 * getOutputProperties().get(String key) will only retrieve properties 72 * that were explicitly set in the stylesheet.</p> 73 * 74 * <p>For XSLT, 75 * <a href="http://www.w3.org/TR/xslt#attribute-value-templates">Attribute 76 * Value Templates</a> attribute values will 77 * be returned unexpanded (since there is no context at this point). The 78 * namespace prefixes inside Attribute Value Templates will be unexpanded, 79 * so that they remain valid XPath values.</p> 80 * 81 * @return A Properties object, never null. 82 */ getOutputProperties()83 Properties getOutputProperties(); 84 } 85