001    /*
002     * Copyright (c) 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 intercepting information about the state transitions that
029     * the tokenizer is making.
030     * 
031     * @version $Id$
032     * @author hsivonen
033     */
034    public interface TransitionHandler {
035    
036        /**
037         * This method is called for every tokenizer state transition.
038         * 
039         * @param from
040         *            the state the tokenizer is transitioning from
041         * @param to
042         *            the state being transitioned to
043         * @param reconsume
044         *            <code>true</code> if the current input character is going to
045         *            be reconsumed in the new state
046         * @param pos
047         *            the current index into the input stream
048         * @throws SAXException
049         *             if something went wrong
050         */
051        void transition(int from, int to, boolean reconsume, int pos)
052                throws SAXException;
053    }