286N/A/*
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/A/*
286N/A * This file is available under and governed by the GNU General Public
286N/A * License version 2 only, as published by the Free Software Foundation.
286N/A * However, the following notice accompanied the original version of this
286N/A * file and, per its terms, should not be removed:
286N/A *
286N/A * Copyright (c) 2004 World Wide Web Consortium,
286N/A *
286N/A * (Massachusetts Institute of Technology, European Research Consortium for
286N/A * Informatics and Mathematics, Keio University). All Rights Reserved. This
286N/A * work is distributed under the W3C(r) Software License [1] in the hope that
286N/A * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
286N/A * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
286N/A *
286N/A * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
286N/A */
286N/A
286N/Apackage org.w3c.dom.ls;
286N/A
286N/A/**
286N/A * This interface represents an output destination for data.
286N/A * <p> This interface allows an application to encapsulate information about
286N/A * an output destination in a single object, which may include a URI, a byte
286N/A * stream (possibly with a specified encoding), a base URI, and/or a
286N/A * character stream.
286N/A * <p> The exact definitions of a byte stream and a character stream are
286N/A * binding dependent.
286N/A * <p> The application is expected to provide objects that implement this
286N/A * interface whenever such objects are needed. The application can either
286N/A * provide its own objects that implement this interface, or it can use the
286N/A * generic factory method <code>DOMImplementationLS.createLSOutput()</code>
286N/A * to create objects that implement this interface.
286N/A * <p> The <code>LSSerializer</code> will use the <code>LSOutput</code> object
286N/A * to determine where to serialize the output to. The
286N/A * <code>LSSerializer</code> will look at the different outputs specified in
286N/A * the <code>LSOutput</code> in the following order to know which one to
286N/A * output to, the first one that is not null and not an empty string will be
286N/A * used:
286N/A * <ol>
286N/A * <li> <code>LSOutput.characterStream</code>
286N/A * </li>
286N/A * <li>
286N/A * <code>LSOutput.byteStream</code>
286N/A * </li>
286N/A * <li> <code>LSOutput.systemId</code>
286N/A * </li>
286N/A * </ol>
286N/A * <p> <code>LSOutput</code> objects belong to the application. The DOM
286N/A * implementation will never modify them (though it may make copies and
286N/A * modify the copies, if necessary).
286N/A * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>Document Object Model (DOM) Level 3 Load
286N/Aand Save Specification</a>.
286N/A */
286N/Apublic interface LSOutput {
286N/A /**
286N/A * An attribute of a language and binding dependent type that represents
286N/A * a writable stream to which 16-bit units can be output.
286N/A */
286N/A public java.io.Writer getCharacterStream();
286N/A /**
286N/A * An attribute of a language and binding dependent type that represents
286N/A * a writable stream to which 16-bit units can be output.
286N/A */
286N/A public void setCharacterStream(java.io.Writer characterStream);
286N/A
286N/A /**
286N/A * An attribute of a language and binding dependent type that represents
286N/A * a writable stream of bytes.
286N/A */
286N/A public java.io.OutputStream getByteStream();
286N/A /**
286N/A * An attribute of a language and binding dependent type that represents
286N/A * a writable stream of bytes.
286N/A */
286N/A public void setByteStream(java.io.OutputStream byteStream);
286N/A
286N/A /**
286N/A * The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], for this
286N/A * output destination.
286N/A * <br> If the system ID is a relative URI reference (see section 5 in [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>]), the
286N/A * behavior is implementation dependent.
286N/A */
286N/A public String getSystemId();
286N/A /**
286N/A * The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], for this
286N/A * output destination.
286N/A * <br> If the system ID is a relative URI reference (see section 5 in [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>]), the
286N/A * behavior is implementation dependent.
286N/A */
286N/A public void setSystemId(String systemId);
286N/A
286N/A /**
286N/A * The character encoding to use for the output. The encoding must be a
286N/A * string acceptable for an XML encoding declaration ([<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] section
286N/A * 4.3.3 "Character Encoding in Entities"), it is recommended that
286N/A * character encodings registered (as charsets) with the Internet
286N/A * Assigned Numbers Authority [<a href='ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets'>IANA-CHARSETS</a>]
286N/A * should be referred to using their registered names.
286N/A */
286N/A public String getEncoding();
286N/A /**
286N/A * The character encoding to use for the output. The encoding must be a
286N/A * string acceptable for an XML encoding declaration ([<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] section
286N/A * 4.3.3 "Character Encoding in Entities"), it is recommended that
286N/A * character encodings registered (as charsets) with the Internet
286N/A * Assigned Numbers Authority [<a href='ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets'>IANA-CHARSETS</a>]
286N/A * should be referred to using their registered names.
286N/A */
286N/A public void setEncoding(String encoding);
286N/A
286N/A}