org.w3c.dom.ls.LSOutput Maven / Gradle / Ivy

/*
 * Copyright (c) 2004 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

package org.w3c.dom.ls;

/**
 *  This interface represents an output destination for data.
 *  This interface allows an application to encapsulate information about
 * an output destination in a single object, which may include a URI, a byte
 * stream (possibly with a specified encoding), a base URI, and/or a
 * character stream.
 * 
 The exact definitions of a byte stream and a character stream are
 * binding dependent.
 * 
 The application is expected to provide objects that implement this
 * interface whenever such objects are needed. The application can either
 * provide its own objects that implement this interface, or it can use the
 * generic factory method DOMImplementationLS.createLSOutput()
 * to create objects that implement this interface.
 * 
 The LSSerializer will use the LSOutput object
 * to determine where to serialize the output to. The
 * LSSerializer will look at the different outputs specified in
 * the LSOutput in the following order to know which one to
 * output to, the first one that is not null and not an empty string will be
 * used:
 * 

 *  LSOutput.characterStream
 * 
 * 
 * LSOutput.byteStream
 * 
 *  LSOutput.systemId
 * 
 * 
 *  LSOutput objects belong to the application. The DOM
 * implementation will never modify them (though it may make copies and
 * modify the copies, if necessary).
 * See also the Document Object Model (DOM) Level 3 Load
and Save Specification.
 */
public interface LSOutput {
    /**
     *  An attribute of a language and binding dependent type that represents
     * a writable stream to which 16-bit units can be output.
     */
    public java.io.Writer getCharacterStream();
    /**
     *  An attribute of a language and binding dependent type that represents
     * a writable stream to which 16-bit units can be output.
     */
    public void setCharacterStream(java.io.Writer characterStream);

    /**
     *  An attribute of a language and binding dependent type that represents
     * a writable stream of bytes.
     */
    public java.io.OutputStream getByteStream();
    /**
     *  An attribute of a language and binding dependent type that represents
     * a writable stream of bytes.
     */
    public void setByteStream(java.io.OutputStream byteStream);

    /**
     *  The system identifier, a URI reference [IETF RFC 2396], for this
     * output destination.
     * 
 If the system ID is a relative URI reference (see section 5 in [IETF RFC 2396]), the
     * behavior is implementation dependent.
     */
    public String getSystemId();
    /**
     *  The system identifier, a URI reference [IETF RFC 2396], for this
     * output destination.
     * 
 If the system ID is a relative URI reference (see section 5 in [IETF RFC 2396]), the
     * behavior is implementation dependent.
     */
    public void setSystemId(String systemId);

    /**
     *  The character encoding to use for the output. The encoding must be a
     * string acceptable for an XML encoding declaration ([XML 1.0] section
     * 4.3.3 "Character Encoding in Entities"), it is recommended that
     * character encodings registered (as charsets) with the Internet
     * Assigned Numbers Authority [IANA-CHARSETS]
     *  should be referred to using their registered names.
     */
    public String getEncoding();
    /**
     *  The character encoding to use for the output. The encoding must be a
     * string acceptable for an XML encoding declaration ([XML 1.0] section
     * 4.3.3 "Character Encoding in Entities"), it is recommended that
     * character encodings registered (as charsets) with the Internet
     * Assigned Numbers Authority [IANA-CHARSETS]
     *  should be referred to using their registered names.
     */
    public void setEncoding(String encoding);

}