286N/A/*
286N/A * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved.
286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
286N/A *
286N/A * This code is free software; you can redistribute it and/or modify it
286N/A * under the terms of the GNU General Public License version 2 only, as
286N/A * published by the Free Software Foundation. Oracle designates this
286N/A * particular file as subject to the "Classpath" exception as provided
286N/A * by Oracle in the LICENSE file that accompanied this code.
286N/A *
286N/A * This code is distributed in the hope that it will be useful, but WITHOUT
286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
286N/A * version 2 for more details (a copy is included in the LICENSE file that
286N/A * accompanied this code).
286N/A *
286N/A * You should have received a copy of the GNU General Public License version
286N/A * 2 along with this work; if not, write to the Free Software Foundation,
286N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
286N/A *
286N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
286N/A * or visit www.oracle.com if you need additional information or have any
286N/A * questions.
286N/A */
286N/A
286N/Apackage javax.xml.transform;
286N/A
286N/A/**
286N/A * <p>An object that implements this interface contains the information
286N/A * needed to build a transformation result tree.</p>
286N/A *
286N/A * @author <a href="Jeff.Suttor@Sun.com">Jeff Suttor</a>
286N/A */
286N/Apublic interface Result {
286N/A
286N/A /**
286N/A * The name of the processing instruction that is sent if the
286N/A * result tree disables output escaping.
286N/A *
286N/A * <p>Normally, result tree serialization escapes & and < (and
286N/A * possibly other characters) when outputting text nodes.
286N/A * This ensures that the output is well-formed XML. However,
286N/A * it is sometimes convenient to be able to produce output that is
286N/A * almost, but not quite well-formed XML; for example,
286N/A * the output may include ill-formed sections that will
286N/A * be transformed into well-formed XML by a subsequent non-XML aware
286N/A * process. If a processing instruction is sent with this name,
286N/A * serialization should be output without any escaping. </p>
286N/A *
286N/A * <p>Result DOM trees may also have PI_DISABLE_OUTPUT_ESCAPING and
286N/A * PI_ENABLE_OUTPUT_ESCAPING inserted into the tree.</p>
286N/A *
286N/A * @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a>
286N/A */
286N/A public static final String PI_DISABLE_OUTPUT_ESCAPING =
286N/A "javax.xml.transform.disable-output-escaping";
286N/A
286N/A /**
286N/A * The name of the processing instruction that is sent
286N/A * if the result tree enables output escaping at some point after having
286N/A * received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.
286N/A *
286N/A * @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a>
286N/A */
286N/A public static final String PI_ENABLE_OUTPUT_ESCAPING =
286N/A "javax.xml.transform.enable-output-escaping";
286N/A
286N/A /**
286N/A * Set the system identifier for this Result.
286N/A *
286N/A * <p>If the Result is not to be written to a file, the system identifier is optional.
286N/A * The application may still want to provide one, however, for use in error messages
286N/A * and warnings, or to resolve relative output identifiers.</p>
286N/A *
286N/A * @param systemId The system identifier as a URI string.
286N/A */
286N/A public void setSystemId(String systemId);
286N/A
286N/A /**
286N/A * Get the system identifier that was set with setSystemId.
286N/A *
286N/A * @return The system identifier that was set with setSystemId,
286N/A * or null if setSystemId was not called.
286N/A */
286N/A public String getSystemId();
286N/A}