javax.xml.transform.Result Java Source 1.6.0


01/*
02 * The contents of this file are subject to the terms
03 * of the Common Development and Distribution License
04 * (the "License").  You may not use this file except
05 * in compliance with the License.
06 *
07 * You can obtain a copy of the license at
08 * https://jaxp.dev.java.net/CDDLv1.0.html.
09 * See the License for the specific language governing
10 * permissions and limitations under the License.
11 *
12 * When distributing Covered Code, include this CDDL
13 * HEADER in each file and include the License file at
14 * https://jaxp.dev.java.net/CDDLv1.0.html
15 * If applicable add the following below this CDDL HEADER
16 * with the fields enclosed by brackets "[]" replaced with
17 * your own identifying information: Portions Copyright
18 * [year] [name of copyright owner]
19 */
20
21/*
22 * $Id: XMLEntityReader.java,v 1.3 2005/11/03 17:02:21 jeffsuttor Exp $
23 * @(#)Result.java	1.21 05/11/17
24 *
25 * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
26 */
27
28package javax.xml.transform;
29
30/**
31 * <p>An object that implements this interface contains the information
32 * needed to build a transformation result tree.</p>
33 * 
34 * @author <a href="Jeff.Suttor@Sun.com">Jeff Suttor</a>
35 */
36public interface Result {
37
38    /**
39     * The name of the processing instruction that is sent if the
40     * result tree disables output escaping.
41     *
42     * <p>Normally, result tree serialization escapes & and < (and
43     * possibly other characters) when outputting text nodes.
44     * This ensures that the output is well-formed XML. However,
45     * it is sometimes convenient to be able to produce output that is
46     * almost, but not quite well-formed XML; for example,
47     * the output may include ill-formed sections that will
48     * be transformed into well-formed XML by a subsequent non-XML aware
49     * process. If a processing instruction is sent with this name,
50     * serialization should be output without any escaping. </p>
51     *
52     * <p>Result DOM trees may also have PI_DISABLE_OUTPUT_ESCAPING and
53     * PI_ENABLE_OUTPUT_ESCAPING inserted into the tree.</p>
54     *
55     * @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a>
56     */
57    public static final String PI_DISABLE_OUTPUT_ESCAPING =
58        "javax.xml.transform.disable-output-escaping";
59
60    /**
61     * The name of the processing instruction that is sent
62     * if the result tree enables output escaping at some point after having
63     * received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.
64     *
65     * @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a>
66     */
67    public static final String PI_ENABLE_OUTPUT_ESCAPING =
68        "javax.xml.transform.enable-output-escaping";
69
70    /**
71     * Set the system identifier for this Result.
72     *
73     * <p>If the Result is not to be written to a file, the system identifier is optional.
74     * The application may still want to provide one, however, for use in error messages
75     * and warnings, or to resolve relative output identifiers.</p>
76     *
77     * @param systemId The system identifier as a URI string.
78     */
79    public void setSystemId(String systemId);
80
81    /**
82     * Get the system identifier that was set with setSystemId.
83     *
84     * @return The system identifier that was set with setSystemId,
85     * or null if setSystemId was not called.
86     */
87    public String getSystemId();
88}