001    /*
002     * Copyright (c) 2007-2008 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 receiving notifications of UTF-16 code units read from a character stream.
029     * 
030     * @version $Id$
031     * @author hsivonen
032     */
033    public interface CharacterHandler {
034    
035        /**
036         * Receive notification of a run of UTF-16 code units.
037         * @param ch the buffer
038         * @param start start index in the buffer
039         * @param length the number of characters to process starting from <code>start</code>
040         * @throws SAXException if things go wrong
041         */
042        public void characters(char[] ch, int start, int length)
043                throws SAXException;
044    
045        /**
046         * Signals the end of the stream. Can be used for cleanup. Doesn't mean that the stream ended successfully.
047         * 
048         * @throws SAXException if things go wrong
049         */
050        public void end() throws SAXException;
051    
052        /**
053         * Signals the start of the stream. Can be used for setup.
054         * 
055         * @throws SAXException if things go wrong
056         */
057        public void start() throws SAXException;
058    
059    }