1 /*
2 * Copyright 2000-2005 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any 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 public interface Templates {
42
43 /**
44 * Create a new transformation context for this Templates object.
45 *
46 * @return A valid non-null instance of a Transformer.
47 *
48 * @throws TransformerConfigurationException if a Transformer can not be created.
49 */
50 Transformer newTransformer() throws TransformerConfigurationException;
51
52 /**
53 * Get the properties corresponding to the effective xsl:output element.
54 * The object returned will
55 * be a clone of the internal values. Accordingly, it can be mutated
56 * without mutating the Templates object, and then handed in to
57 * {@link javax.xml.transform.Transformer#setOutputProperties}.
58 *
59 * <p>The properties returned should contain properties set by the stylesheet,
60 * and these properties are "defaulted" by default properties specified by
61 * <a href="http://www.w3.org/TR/xslt#output">section 16 of the
62 * XSL Transformations (XSLT) W3C Recommendation</a>. The properties that
63 * were specifically set by the stylesheet should be in the base
64 * Properties list, while the XSLT default properties that were not
65 * specifically set should be in the "default" Properties list. Thus,
66 * getOutputProperties().getProperty(String key) will obtain any
67 * property in that was set by the stylesheet, <em>or</em> the default
68 * properties, while
69 * getOutputProperties().get(String key) will only retrieve properties
70 * that were explicitly set in the stylesheet.</p>
71 *
72 * <p>For XSLT,
73 * <a href="http://www.w3.org/TR/xslt#attribute-value-templates">Attribute
74 * Value Templates</a> attribute values will
75 * be returned unexpanded (since there is no context at this point). The
76 * namespace prefixes inside Attribute Value Templates will be unexpanded,
77 * so that they remain valid XPath values.</p>
78 *
79 * @return A Properties object, never null.
80 */
81 Properties getOutputProperties();
82 }
Save This Page