|
1 /* |
|
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
3 * |
|
4 * This code is free software; you can redistribute it and/or modify it |
|
5 * under the terms of the GNU General Public License version 2 only, as |
|
6 * published by the Free Software Foundation. Sun designates this |
|
7 * particular file as subject to the "Classpath" exception as provided |
|
8 * by Sun in the LICENSE file that accompanied this code. |
|
9 * |
|
10 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
13 * version 2 for more details (a copy is included in the LICENSE file that |
|
14 * accompanied this code). |
|
15 * |
|
16 * You should have received a copy of the GNU General Public License version |
|
17 * 2 along with this work; if not, write to the Free Software Foundation, |
|
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
19 * |
|
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
|
21 * CA 95054 USA or visit www.sun.com if you need additional information or |
|
22 * have any questions. |
|
23 */ |
|
24 |
|
25 /* |
|
26 * This file is available under and governed by the GNU General Public |
|
27 * License version 2 only, as published by the Free Software Foundation. |
|
28 * However, the following notice accompanied the original version of this |
|
29 * file and, per its terms, should not be removed: |
|
30 * |
|
31 * Copyright (c) 2004 World Wide Web Consortium, |
|
32 * |
|
33 * (Massachusetts Institute of Technology, European Research Consortium for |
|
34 * Informatics and Mathematics, Keio University). All Rights Reserved. This |
|
35 * work is distributed under the W3C(r) Software License [1] in the hope that |
|
36 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied |
|
37 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
38 * |
|
39 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 |
|
40 */ |
|
41 |
|
42 package org.w3c.dom.ls; |
|
43 |
|
44 /** |
|
45 * This interface represents an output destination for data. |
|
46 * <p> This interface allows an application to encapsulate information about |
|
47 * an output destination in a single object, which may include a URI, a byte |
|
48 * stream (possibly with a specified encoding), a base URI, and/or a |
|
49 * character stream. |
|
50 * <p> The exact definitions of a byte stream and a character stream are |
|
51 * binding dependent. |
|
52 * <p> The application is expected to provide objects that implement this |
|
53 * interface whenever such objects are needed. The application can either |
|
54 * provide its own objects that implement this interface, or it can use the |
|
55 * generic factory method <code>DOMImplementationLS.createLSOutput()</code> |
|
56 * to create objects that implement this interface. |
|
57 * <p> The <code>LSSerializer</code> will use the <code>LSOutput</code> object |
|
58 * to determine where to serialize the output to. The |
|
59 * <code>LSSerializer</code> will look at the different outputs specified in |
|
60 * the <code>LSOutput</code> in the following order to know which one to |
|
61 * output to, the first one that is not null and not an empty string will be |
|
62 * used: |
|
63 * <ol> |
|
64 * <li> <code>LSOutput.characterStream</code> |
|
65 * </li> |
|
66 * <li> |
|
67 * <code>LSOutput.byteStream</code> |
|
68 * </li> |
|
69 * <li> <code>LSOutput.systemId</code> |
|
70 * </li> |
|
71 * </ol> |
|
72 * <p> <code>LSOutput</code> objects belong to the application. The DOM |
|
73 * implementation will never modify them (though it may make copies and |
|
74 * modify the copies, if necessary). |
|
75 * <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 |
|
76 and Save Specification</a>. |
|
77 */ |
|
78 public interface LSOutput { |
|
79 /** |
|
80 * An attribute of a language and binding dependent type that represents |
|
81 * a writable stream to which 16-bit units can be output. |
|
82 */ |
|
83 public java.io.Writer getCharacterStream(); |
|
84 /** |
|
85 * An attribute of a language and binding dependent type that represents |
|
86 * a writable stream to which 16-bit units can be output. |
|
87 */ |
|
88 public void setCharacterStream(java.io.Writer characterStream); |
|
89 |
|
90 /** |
|
91 * An attribute of a language and binding dependent type that represents |
|
92 * a writable stream of bytes. |
|
93 */ |
|
94 public java.io.OutputStream getByteStream(); |
|
95 /** |
|
96 * An attribute of a language and binding dependent type that represents |
|
97 * a writable stream of bytes. |
|
98 */ |
|
99 public void setByteStream(java.io.OutputStream byteStream); |
|
100 |
|
101 /** |
|
102 * The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], for this |
|
103 * output destination. |
|
104 * <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 |
|
105 * behavior is implementation dependent. |
|
106 */ |
|
107 public String getSystemId(); |
|
108 /** |
|
109 * The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], for this |
|
110 * output destination. |
|
111 * <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 |
|
112 * behavior is implementation dependent. |
|
113 */ |
|
114 public void setSystemId(String systemId); |
|
115 |
|
116 /** |
|
117 * The character encoding to use for the output. The encoding must be a |
|
118 * string acceptable for an XML encoding declaration ([<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] section |
|
119 * 4.3.3 "Character Encoding in Entities"), it is recommended that |
|
120 * character encodings registered (as charsets) with the Internet |
|
121 * Assigned Numbers Authority [<a href='ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets'>IANA-CHARSETS</a>] |
|
122 * should be referred to using their registered names. |
|
123 */ |
|
124 public String getEncoding(); |
|
125 /** |
|
126 * The character encoding to use for the output. The encoding must be a |
|
127 * string acceptable for an XML encoding declaration ([<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] section |
|
128 * 4.3.3 "Character Encoding in Entities"), it is recommended that |
|
129 * character encodings registered (as charsets) with the Internet |
|
130 * Assigned Numbers Authority [<a href='ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets'>IANA-CHARSETS</a>] |
|
131 * should be referred to using their registered names. |
|
132 */ |
|
133 public void setEncoding(String encoding); |
|
134 |
|
135 } |