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 /** 29 * <p>An object that implements this interface contains the information 30 * needed to build a transformation result tree.</p> 31 * 32 * @author <a href="Jeff.Suttor@Sun.com">Jeff Suttor</a> 33 */ 34 public interface Result { 35 36 /** 37 * The name of the processing instruction that is sent if the 38 * result tree disables output escaping. 39 * 40 * <p>Normally, result tree serialization escapes & and < (and 41 * possibly other characters) when outputting text nodes. 42 * This ensures that the output is well-formed XML. However, 43 * it is sometimes convenient to be able to produce output that is 44 * almost, but not quite well-formed XML; for example, 45 * the output may include ill-formed sections that will 46 * be transformed into well-formed XML by a subsequent non-XML aware 47 * process. If a processing instruction is sent with this name, 48 * serialization should be output without any escaping. </p> 49 * 50 * <p>Result DOM trees may also have PI_DISABLE_OUTPUT_ESCAPING and 51 * PI_ENABLE_OUTPUT_ESCAPING inserted into the tree.</p> 52 * 53 * @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a> 54 */ 55 public static final String PI_DISABLE_OUTPUT_ESCAPING = 56 "javax.xml.transform.disable-output-escaping"; 57 58 /** 59 * The name of the processing instruction that is sent 60 * if the result tree enables output escaping at some point after having 61 * received a PI_DISABLE_OUTPUT_ESCAPING processing instruction. 62 * 63 * @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a> 64 */ 65 public static final String PI_ENABLE_OUTPUT_ESCAPING = 66 "javax.xml.transform.enable-output-escaping"; 67 68 /** 69 * Set the system identifier for this Result. 70 * 71 * <p>If the Result is not to be written to a file, the system identifier is optional. 72 * The application may still want to provide one, however, for use in error messages 73 * and warnings, or to resolve relative output identifiers.</p> 74 * 75 * @param systemId The system identifier as a URI string. 76 */ 77 public void setSystemId(String systemId); 78 79 /** 80 * Get the system identifier that was set with setSystemId. 81 * 82 * @return The system identifier that was set with setSystemId, 83 * or null if setSystemId was not called. 84 */ 85 public String getSystemId(); 86 }