001: /*
002: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * 1. Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: * 2. Redistributions in binary form must reproduce the above copyright notice,
010: * this list of conditions and the following disclaimer in the documentation
011: * and/or other materials provided with the distribution.
012: * 3. The end-user documentation included with the redistribution, if any, must
013: * include the following acknowledgment:
014: *
015: * "This product includes software developed by Gargoyle Software Inc.
016: * (http://www.GargoyleSoftware.com/)."
017: *
018: * Alternately, this acknowledgment may appear in the software itself, if
019: * and wherever such third-party acknowledgments normally appear.
020: * 4. The name "Gargoyle Software" must not be used to endorse or promote
021: * products derived from this software without prior written permission.
022: * For written permission, please contact info@GargoyleSoftware.com.
023: * 5. Products derived from this software may not be called "HtmlUnit", nor may
024: * "HtmlUnit" appear in their name, without prior written permission of
025: * Gargoyle Software Inc.
026: *
027: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
028: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
029: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
030: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
031: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
032: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
033: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
034: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
035: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
036: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
037: */
038: package com.gargoylesoftware.htmlunit.html;
039:
040: import java.net.URL;
041:
042: import org.apache.commons.logging.Log;
043: import org.apache.commons.logging.LogFactory;
044:
045: /**
046: * Listener for messages from the html parser. <br/>
047: * The classification of problems as warnings or errors is the one of the html parser
048: * used by htmlunit. The line and column may indicates the position of the problem detected
049: * by the parser. This is only an indication and in some cases the position where
050: * the problem has to be solved is located lines before.
051: *
052: * @version $Revision: 2132 $
053: * @author Marc Guillemot
054: */
055: public interface HTMLParserListener {
056:
057: /**
058: * Simple implementation of {@link HTMLParserListener} logging the received warnings
059: * and errors in the "com.gargoylesoftware.htmlunit.html.HTMLParserListener" log.<br/>
060: * Errors are logged at the error level and warnings at the warning level.
061: */
062: HTMLParserListener LOG_REPORTER = new HTMLParserListener() {
063: protected final Log getLog() {
064: return LogFactory.getLog(HTMLParserListener.class);
065: }
066:
067: public void error(final String message, final URL url,
068: final int line, final int column, final String key) {
069: getLog().error(format(message, url, line, column, key));
070: }
071:
072: public void warning(final String message, final URL url,
073: final int line, final int column, final String key) {
074: getLog().warn(format(message, url, line, column, key));
075: }
076:
077: private String format(final String message, final URL url,
078: final int line, final int column, final String key) {
079: final StringBuffer buffer = new StringBuffer(message);
080: buffer.append(" (");
081: buffer.append(url.toExternalForm());
082: buffer.append(" ");
083: buffer.append(line);
084: buffer.append(":");
085: buffer.append(column);
086: buffer.append(")");
087: return buffer.toString();
088: }
089: };
090:
091: /**
092: * Called when the html parser reports an error.
093: * @param message the description of the problem
094: * @param url the url of the document in which the problem occurs
095: * @param line the line of the problem
096: * @param column the column of the problem
097: * @param key the key identifying the "type" of problem. May be interesting to filter messages.
098: */
099: void error(final String message, final URL url, final int line,
100: final int column, final String key);
101:
102: /**
103: * Called when the html parser reports a warning.
104: * @param message the description of the problem
105: * @param url the url of the document in which the problem occurs
106: * @param line the line of the problem
107: * @param column the column of the problem
108: * @param key the key identifying the "type" of problem. May be interesting to filter messages.
109: */
110: void warning(final String message, final URL url, final int line,
111: final int column, final String key);
112: }
|