001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
003 *
004 * This code is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU General Public License version 2 only, as
006 * published by the Free Software Foundation. Sun designates this
007 * particular file as subject to the "Classpath" exception as provided
008 * by Sun in the LICENSE file that accompanied this code.
009 *
010 * This code is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
013 * version 2 for more details (a copy is included in the LICENSE file that
014 * accompanied this code).
015 *
016 * You should have received a copy of the GNU General Public License version
017 * 2 along with this work; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
019 *
020 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
021 * CA 95054 USA or visit www.sun.com if you need additional information or
022 * have any questions.
023 */
024
025 /*
026 * This file is available under and governed by the GNU General Public
027 * License version 2 only, as published by the Free Software Foundation.
028 * However, the following notice accompanied the original version of this
029 * file and, per its terms, should not be removed:
030 *
031 * Copyright (c) 2004 World Wide Web Consortium,
032 *
033 * (Massachusetts Institute of Technology, European Research Consortium for
034 * Informatics and Mathematics, Keio University). All Rights Reserved. This
035 * work is distributed under the W3C(r) Software License [1] in the hope that
036 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
037 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
038 *
039 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
040 */
041
042 package org.w3c.dom.ls;
043
044 /**
045 * This interface represents an output destination for data.
046 * <p> This interface allows an application to encapsulate information about
047 * an output destination in a single object, which may include a URI, a byte
048 * stream (possibly with a specified encoding), a base URI, and/or a
049 * character stream.
050 * <p> The exact definitions of a byte stream and a character stream are
051 * binding dependent.
052 * <p> The application is expected to provide objects that implement this
053 * interface whenever such objects are needed. The application can either
054 * provide its own objects that implement this interface, or it can use the
055 * generic factory method <code>DOMImplementationLS.createLSOutput()</code>
056 * to create objects that implement this interface.
057 * <p> The <code>LSSerializer</code> will use the <code>LSOutput</code> object
058 * to determine where to serialize the output to. The
059 * <code>LSSerializer</code> will look at the different outputs specified in
060 * the <code>LSOutput</code> in the following order to know which one to
061 * output to, the first one that is not null and not an empty string will be
062 * used:
063 * <ol>
064 * <li> <code>LSOutput.characterStream</code>
065 * </li>
066 * <li>
067 * <code>LSOutput.byteStream</code>
068 * </li>
069 * <li> <code>LSOutput.systemId</code>
070 * </li>
071 * </ol>
072 * <p> <code>LSOutput</code> objects belong to the application. The DOM
073 * implementation will never modify them (though it may make copies and
074 * modify the copies, if necessary).
075 * <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
076 and Save Specification</a>.
077 */
078 public interface LSOutput {
079 /**
080 * An attribute of a language and binding dependent type that represents
081 * a writable stream to which 16-bit units can be output.
082 */
083 public java.io.Writer getCharacterStream();
084
085 /**
086 * An attribute of a language and binding dependent type that represents
087 * a writable stream to which 16-bit units can be output.
088 */
089 public void setCharacterStream(java.io.Writer characterStream);
090
091 /**
092 * An attribute of a language and binding dependent type that represents
093 * a writable stream of bytes.
094 */
095 public java.io.OutputStream getByteStream();
096
097 /**
098 * An attribute of a language and binding dependent type that represents
099 * a writable stream of bytes.
100 */
101 public void setByteStream(java.io.OutputStream byteStream);
102
103 /**
104 * The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], for this
105 * output destination.
106 * <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
107 * behavior is implementation dependent.
108 */
109 public String getSystemId();
110
111 /**
112 * The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], for this
113 * output destination.
114 * <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
115 * behavior is implementation dependent.
116 */
117 public void setSystemId(String systemId);
118
119 /**
120 * The character encoding to use for the output. The encoding must be a
121 * string acceptable for an XML encoding declaration ([<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] section
122 * 4.3.3 "Character Encoding in Entities"), it is recommended that
123 * character encodings registered (as charsets) with the Internet
124 * Assigned Numbers Authority [<a href='ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets'>IANA-CHARSETS</a>]
125 * should be referred to using their registered names.
126 */
127 public String getEncoding();
128
129 /**
130 * The character encoding to use for the output. The encoding must be a
131 * string acceptable for an XML encoding declaration ([<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] section
132 * 4.3.3 "Character Encoding in Entities"), it is recommended that
133 * character encodings registered (as charsets) with the Internet
134 * Assigned Numbers Authority [<a href='ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets'>IANA-CHARSETS</a>]
135 * should be referred to using their registered names.
136 */
137 public void setEncoding(String encoding);
138
139 }
|