nu.validator.source.SourceHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of validator Show documentation

An HTML-checking library (used by https://html5.validator.nu and the HTML5 facet of the W3C Validator)

There is a newer version: 20.7.2

/*
 * Copyright (c) 2007 Mozilla Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a 
 * copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the 
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 */

package nu.validator.source;

import java.util.SortedSet;

import org.xml.sax.SAXException;

public interface SourceHandler {

    public void startSource(String type, String encoding) throws SAXException;
    
    public void setLineErrors(SortedSet oneBasedLineErrors) throws SAXException;
    
    public void endSource() throws SAXException;

    /**
     * Append a string consisting of the characters from ch[start] thru ch[start+length-1] inclusive to the source
     * text.
     * @see java.lang.StringBuffer#append(char[], int, int)
     * @see org.xml.sax.ContentHandler#characters(char[], int, int)
     */
    public void characters(char[] ch, int start, int length) throws SAXException;
    
    public void newLine() throws SAXException;
    
    public void startRange(int oneBasedLine, int oneBasedColumn) throws SAXException;

    public void endRange() throws SAXException;
    
    public void startCharHilite(int oneBasedLine, int oneBasedColumn) throws SAXException;

    public void endCharHilite() throws SAXException;

}