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 input source for data.
286N/A * <p> This interface allows an application to encapsulate information about
286N/A * an input source in a single object, which may include a public
286N/A * identifier, a system identifier, a byte stream (possibly with a specified
286N/A * encoding), a base URI, and/or 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.createLSInput()</code>
286N/A * to create objects that implement this interface.
286N/A * <p> The <code>LSParser</code> will use the <code>LSInput</code> object to
286N/A * determine how to read data. The <code>LSParser</code> will look at the
286N/A * different inputs specified in the <code>LSInput</code> in the following
286N/A * order to know which one to read from, the first one that is not null and
286N/A * not an empty string will be used:
286N/A * <ol>
286N/A * <li> <code>LSInput.characterStream</code>
286N/A * </li>
286N/A * <li>
286N/A * <code>LSInput.byteStream</code>
286N/A * </li>
286N/A * <li> <code>LSInput.stringData</code>
286N/A * </li>
286N/A * <li>
286N/A * <code>LSInput.systemId</code>
286N/A * </li>
286N/A * <li> <code>LSInput.publicId</code>
286N/A * </li>
286N/A * </ol>
286N/A * <p> If all inputs are null, the <code>LSParser</code> will report a
286N/A * <code>DOMError</code> with its <code>DOMError.type</code> set to
286N/A * <code>"no-input-specified"</code> and its <code>DOMError.severity</code>
286N/A * set to <code>DOMError.SEVERITY_FATAL_ERROR</code>.
286N/A * <p> <code>LSInput</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 LSInput {
286N/A /**
286N/A * An attribute of a language and binding dependent type that represents
286N/A * a stream of 16-bit units. The application must encode the stream
286N/A * using UTF-16 (defined in [Unicode] and in [ISO/IEC 10646]). It is not a requirement to have an XML declaration when
286N/A * using character streams. If an XML declaration is present, the value
286N/A * of the encoding attribute will be ignored.
286N/A */
286N/A public java.io.Reader getCharacterStream();
286N/A /**
286N/A * An attribute of a language and binding dependent type that represents
286N/A * a stream of 16-bit units. The application must encode the stream
286N/A * using UTF-16 (defined in [Unicode] and in [ISO/IEC 10646]). It is not a requirement to have an XML declaration when
286N/A * using character streams. If an XML declaration is present, the value
286N/A * of the encoding attribute will be ignored.
286N/A */
286N/A public void setCharacterStream(java.io.Reader characterStream);
286N/A
286N/A /**
286N/A * An attribute of a language and binding dependent type that represents
286N/A * a stream of bytes.
286N/A * <br> If the application knows the character encoding of the byte
286N/A * stream, it should set the encoding attribute. Setting the encoding in
286N/A * this way will override any encoding specified in an XML declaration
286N/A * in the data.
286N/A */
286N/A public java.io.InputStream getByteStream();
286N/A /**
286N/A * An attribute of a language and binding dependent type that represents
286N/A * a stream of bytes.
286N/A * <br> If the application knows the character encoding of the byte
286N/A * stream, it should set the encoding attribute. Setting the encoding in
286N/A * this way will override any encoding specified in an XML declaration
286N/A * in the data.
286N/A */
286N/A public void setByteStream(java.io.InputStream byteStream);
286N/A
286N/A /**
286N/A * String data to parse. If provided, this will always be treated as a
286N/A * sequence of 16-bit units (UTF-16 encoded characters). It is not a
286N/A * requirement to have an XML declaration when using
286N/A * <code>stringData</code>. If an XML declaration is present, the value
286N/A * of the encoding attribute will be ignored.
286N/A */
286N/A public String getStringData();
286N/A /**
286N/A * String data to parse. If provided, this will always be treated as a
286N/A * sequence of 16-bit units (UTF-16 encoded characters). It is not a
286N/A * requirement to have an XML declaration when using
286N/A * <code>stringData</code>. If an XML declaration is present, the value
286N/A * of the encoding attribute will be ignored.
286N/A */
286N/A public void setStringData(String stringData);
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 * input source. The system identifier is optional if there is a byte
286N/A * stream, a character stream, or string data. It is still useful to
286N/A * provide one, since the application will use it to resolve any
286N/A * relative URIs and can include it in error messages and warnings. (The
286N/A * LSParser will only attempt to fetch the resource identified by the
286N/A * URI reference if there is no other input available in the input
286N/A * source.)
286N/A * <br> If the application knows the character encoding of the object
286N/A * pointed to by the system identifier, it can set the encoding using
286N/A * the <code>encoding</code> attribute.
286N/A * <br> If the specified system ID is a relative URI reference (see
286N/A * section 5 in [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>]), the DOM
286N/A * implementation will attempt to resolve the relative URI with the
286N/A * <code>baseURI</code> as the base, if that fails, the behavior is
286N/A * 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 * input source. The system identifier is optional if there is a byte
286N/A * stream, a character stream, or string data. It is still useful to
286N/A * provide one, since the application will use it to resolve any
286N/A * relative URIs and can include it in error messages and warnings. (The
286N/A * LSParser will only attempt to fetch the resource identified by the
286N/A * URI reference if there is no other input available in the input
286N/A * source.)
286N/A * <br> If the application knows the character encoding of the object
286N/A * pointed to by the system identifier, it can set the encoding using
286N/A * the <code>encoding</code> attribute.
286N/A * <br> If the specified system ID is a relative URI reference (see
286N/A * section 5 in [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>]), the DOM
286N/A * implementation will attempt to resolve the relative URI with the
286N/A * <code>baseURI</code> as the base, if that fails, the behavior is
286N/A * implementation dependent.
286N/A */
286N/A public void setSystemId(String systemId);
286N/A
286N/A /**
286N/A * The public identifier for this input source. This may be mapped to an
286N/A * input source using an implementation dependent mechanism (such as
286N/A * catalogues or other mappings). The public identifier, if specified,
286N/A * may also be reported as part of the location information when errors
286N/A * are reported.
286N/A */
286N/A public String getPublicId();
286N/A /**
286N/A * The public identifier for this input source. This may be mapped to an
286N/A * input source using an implementation dependent mechanism (such as
286N/A * catalogues or other mappings). The public identifier, if specified,
286N/A * may also be reported as part of the location information when errors
286N/A * are reported.
286N/A */
286N/A public void setPublicId(String publicId);
286N/A
286N/A /**
286N/A * The base URI to be used (see section 5.1.4 in [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>]) for
286N/A * resolving a relative <code>systemId</code> to an absolute URI.
286N/A * <br> If, when used, the base URI is itself a relative URI, an empty
286N/A * string, or null, the behavior is implementation dependent.
286N/A */
286N/A public String getBaseURI();
286N/A /**
286N/A * The base URI to be used (see section 5.1.4 in [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>]) for
286N/A * resolving a relative <code>systemId</code> to an absolute URI.
286N/A * <br> If, when used, the base URI is itself a relative URI, an empty
286N/A * string, or null, the behavior is implementation dependent.
286N/A */
286N/A public void setBaseURI(String baseURI);
286N/A
286N/A /**
286N/A * The character encoding, if known. The encoding must be a string
286N/A * 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").
286N/A * <br> This attribute has no effect when the application provides a
286N/A * character stream or string data. For other sources of input, an
286N/A * encoding specified by means of this attribute will override any
286N/A * encoding specified in the XML declaration or the Text declaration, or
286N/A * an encoding obtained from a higher level protocol, such as HTTP [<a href='http://www.ietf.org/rfc/rfc2616.txt'>IETF RFC 2616</a>].
286N/A */
286N/A public String getEncoding();
286N/A /**
286N/A * The character encoding, if known. The encoding must be a string
286N/A * 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").
286N/A * <br> This attribute has no effect when the application provides a
286N/A * character stream or string data. For other sources of input, an
286N/A * encoding specified by means of this attribute will override any
286N/A * encoding specified in the XML declaration or the Text declaration, or
286N/A * an encoding obtained from a higher level protocol, such as HTTP [<a href='http://www.ietf.org/rfc/rfc2616.txt'>IETF RFC 2616</a>].
286N/A */
286N/A public void setEncoding(String encoding);
286N/A
286N/A /**
286N/A * If set to true, assume that the input is certified (see section 2.13
286N/A * in [<a href='http://www.w3.org/TR/2004/REC-xml11-20040204/'>XML 1.1</a>]) when
286N/A * parsing [<a href='http://www.w3.org/TR/2004/REC-xml11-20040204/'>XML 1.1</a>].
286N/A */
286N/A public boolean getCertifiedText();
286N/A /**
286N/A * If set to true, assume that the input is certified (see section 2.13
286N/A * in [<a href='http://www.w3.org/TR/2004/REC-xml11-20040204/'>XML 1.1</a>]) when
286N/A * parsing [<a href='http://www.w3.org/TR/2004/REC-xml11-20040204/'>XML 1.1</a>].
286N/A */
286N/A public void setCertifiedText(boolean certifiedText);
286N/A
286N/A}