001    /*
002     * Copyright (c) 2005 Marko Karppinen & Co. LLC
003     *
004     * Permission is hereby granted, free of charge, to any person obtaining a 
005     * copy of this software and associated documentation files (the "Software"), 
006     * to deal in the Software without restriction, including without limitation 
007     * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
008     * and/or sell copies of the Software, and to permit persons to whom the 
009     * Software is furnished to do so, subject to the following conditions:
010     *
011     * The above copyright notice and this permission notice shall be included in 
012     * all copies or substantial portions of the Software.
013     *
014     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
015     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
016     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
017     * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
018     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
019     * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
020     * DEALINGS IN THE SOFTWARE.
021     */
022    
023    package fi.karppinen.xml;
024    
025    import org.xml.sax.SAXException;
026    
027    /**
028     * This is an unofficial SAX extension interface for receiving a notification when 
029     * an XML declaration is seen.
030     * 
031     * @author hsivonen
032     */
033    public interface XmlDeclarationHandler {
034        /**
035         * The SAX property string for this interface.
036         */
037        public final static String XML_DECLARATION_HANDLER = "http://karppinen.fi/sax/XmlDeclarationHandler";
038    
039        /**
040         * Receive a notification of the XML declaration.
041         * @param version the XML version number
042         * @param encoding the <code>encoding</code> pseudo-attribute or <code>null</code>
043         *        if not present
044         * @param standalone the <code>standalone</code> pseudo-attribute or <code>null</code>
045         *        if not present
046         * @throws SAXException any SAX exception, possibly wrapping another exception
047         */
048        public void xmlDecl(String version, String encoding, String standalone) throws SAXException;
049    }