content: /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
   *
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
   * obtain a copy of the License at
   * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
   * or packager/legal/LICENSE.txt.  See the License for the specific
   * language governing permissions and limitations under the License.
   *
   * When distributing the software, include this License Header Notice in each
   * file and include the License file at packager/legal/LICENSE.txt.
   *
   * GPL Classpath Exception:
   * Oracle designates this particular file as subject to the "Classpath"
   * exception as provided by Oracle in the GPL Version 2 section of the License
   * file that accompanied this code.
   *
   * Modifications:
   * If applicable, add the following below the License Header, with the fields
   * enclosed by brackets [] replaced by your own identifying information:
   * "Portions Copyright [year] [name of copyright owner]"
   *
   * Contributor(s):
   * If you wish your version of this file to be governed by only the CDDL or
   * only the GPL Version 2, indicate your decision by adding "[Contributor]
   * elects to include this software in this distribution under the [CDDL or GPL
   * Version 2] license."  If you don't indicate a single choice of license, a
   * recipient has the option to distribute your version of this file under
   * either the CDDL, the GPL Version 2 or to extend the choice of license to
   * its licensees as provided above.  However, if you add GPL Version 2 code
   * and therefore, elected the GPL Version 2 license, then the option applies
   * only if the new code is made subject to such option by the copyright
   * holder.
   */
  
  /*
   * $Id: Result.java,v 1.5 2010-11-01 04:36:11 joehw Exp $
   * %W% %E%
   */
  package mf.javax.xml.transform;
  
  /**
   * <p>An object that implements this interface contains the information
   * needed to build a transformation result tree.</p>
   *
   * @author <a href="Jeff.Suttor@Sun.com">Jeff Suttor</a>
   */
  public interface Result {
  
      /**
       * The name of the processing instruction that is sent if the
       * result tree disables output escaping.
       * <p/>
       * <p>Normally, result tree serialization escapes & and < (and
       * possibly other characters) when outputting text nodes.
       * This ensures that the output is well-formed XML. However,
       * it is sometimes convenient to be able to produce output that is
       * almost, but not quite well-formed XML; for example,
       * the output may include ill-formed sections that will
       * be transformed into well-formed XML by a subsequent non-XML aware
       * process. If a processing instruction is sent with this name,
       * serialization should be output without any escaping. </p>
       * <p/>
       * <p>Result DOM trees may also have PI_DISABLE_OUTPUT_ESCAPING and
       * PI_ENABLE_OUTPUT_ESCAPING inserted into the tree.</p>
       *
       * @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a>
       */
      String PI_DISABLE_OUTPUT_ESCAPING =
              "mf.javax.xml.transform.disable-output-escaping";
  
      /**
       * The name of the processing instruction that is sent
       * if the result tree enables output escaping at some point after having
       * received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.
       *
       * @see <a href="http://www.w3.org/TR/xslt#disable-output-escaping">disable-output-escaping in XSLT Specification</a>
       */
      String PI_ENABLE_OUTPUT_ESCAPING =
              "mf.javax.xml.transform.enable-output-escaping";
  
      /**
       * Get the system identifier that was set with setSystemId.
       *
       * @return The system identifier that was set with setSystemId,
       * or null if setSystemId was not called.
       */
      String getSystemId();
  
      /**
       * Set the system identifier for this Result.
       * <p/>
       * <p>If the Result is not to be written to a file, the system identifier is optional.
       * The application may still want to provide one, however, for use in error messages
       * and warnings, or to resolve relative output identifiers.</p>
       *
       * @param systemId The system identifier as a URI string.
       */
      void setSystemId(String systemId);
  }
  