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. Oracle designates this 7 * particular file as subject to the "Classpath" exception as provided 8 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 * or visit www.oracle.com if you need additional information or have any 22 * 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 42package 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 76and Save Specification</a>. 77 * 78 * @since 1.5 79 */ 80public interface LSOutput { 81 /** 82 * An attribute of a language and binding dependent type that represents 83 * a writable stream to which 16-bit units can be output. 84 */ 85 public java.io.Writer getCharacterStream(); 86 /** 87 * An attribute of a language and binding dependent type that represents 88 * a writable stream to which 16-bit units can be output. 89 */ 90 public void setCharacterStream(java.io.Writer characterStream); 91 92 /** 93 * An attribute of a language and binding dependent type that represents 94 * a writable stream of bytes. 95 */ 96 public java.io.OutputStream getByteStream(); 97 /** 98 * An attribute of a language and binding dependent type that represents 99 * 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 * The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], for this 112 * output destination. 113 * <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 114 * behavior is implementation dependent. 115 */ 116 public void setSystemId(String systemId); 117 118 /** 119 * The character encoding to use for the output. The encoding must be a 120 * string acceptable for an XML encoding declaration ([<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] section 121 * 4.3.3 "Character Encoding in Entities"), it is recommended that 122 * character encodings registered (as charsets) with the Internet 123 * Assigned Numbers Authority [<a href='ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets'>IANA-CHARSETS</a>] 124 * should be referred to using their registered names. 125 */ 126 public String getEncoding(); 127 /** 128 * The character encoding to use for the output. The encoding must be a 129 * string acceptable for an XML encoding declaration ([<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] section 130 * 4.3.3 "Character Encoding in Entities"), it is recommended that 131 * character encodings registered (as charsets) with the Internet 132 * Assigned Numbers Authority [<a href='ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets'>IANA-CHARSETS</a>] 133 * should be referred to using their registered names. 134 */ 135 public void setEncoding(String encoding); 136 137} 138