001    /*
002     * Copyright (c) 2008-2010 Mozilla Foundation
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 nu.validator.htmlparser.common;
024    
025    import org.xml.sax.SAXException;
026    
027    /**
028     * An interface for communicating about character encoding names with the
029     * environment of the parser.
030     * 
031     * @version $Id$
032     * @author hsivonen
033     */
034    public interface EncodingDeclarationHandler {
035    
036        /**
037         * Indicates that the parser has found an internal encoding declaration with
038         * the charset value <code>charset</code>.
039         * 
040         * @param charset
041         *            the charset name found.
042         * @return <code>true</code> if the value of <code>charset</code> was an 
043         * encoding name for a supported ASCII-superset encoding.
044         * @throws SAXException
045         *             if something went wrong
046         */
047        public boolean internalEncodingDeclaration(String charset) throws SAXException;
048    
049        /**
050         * Queries the environment for the encoding in use (for error reporting).
051         * 
052         * @return the encoding in use
053         * @throws SAXException
054         *             if something went wrong
055         */
056        public String getCharacterEncoding() throws SAXException;
057    
058    }