KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > gargoylesoftware > htmlunit > html > HTMLParserListener


1 /*
2  * Copyright (c) 2002, 2005 Gargoyle Software Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright notice,
10  * this list of conditions and the following disclaimer in the documentation
11  * and/or other materials provided with the distribution.
12  * 3. The end-user documentation included with the redistribution, if any, must
13  * include the following acknowledgment:
14  *
15  * "This product includes software developed by Gargoyle Software Inc.
16  * (http://www.GargoyleSoftware.com/)."
17  *
18  * Alternately, this acknowledgment may appear in the software itself, if
19  * and wherever such third-party acknowledgments normally appear.
20  * 4. The name "Gargoyle Software" must not be used to endorse or promote
21  * products derived from this software without prior written permission.
22  * For written permission, please contact info@GargoyleSoftware.com.
23  * 5. Products derived from this software may not be called "HtmlUnit", nor may
24  * "HtmlUnit" appear in their name, without prior written permission of
25  * Gargoyle Software Inc.
26  *
27  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30  * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */
38 package com.gargoylesoftware.htmlunit.html;
39
40 import java.net.URL JavaDoc;
41
42 import org.apache.commons.logging.Log;
43 import org.apache.commons.logging.LogFactory;
44
45 /**
46  * Listener for messages from the html parser. <br/>
47  * The classification of problems as warnings or errors is the one of the html parser
48  * used by htmlunit. The line and column may indicates the position of the problem detected
49  * by the parser. This is only an indication and in some cases the position where
50  * the problem has to be solved is located lines before.
51  * @version $Revision: 100 $
52  * @author Marc Guillemot
53  */
54 public interface HTMLParserListener {
55    
56     /**
57      * Simple implementation of {@link HTMLParserListener} logging the received warnings
58      * and errors in the "com.gargoylesoftware.htmlunit.html.HTMLParserListener" log.<br/>
59      * Errors are logged at the error level and warnings at the warning level.
60      */
61     HTMLParserListener LOG_REPORTER = new HTMLParserListener()
62     {
63         protected final Log getLog() {
64             return LogFactory.getLog(HTMLParserListener.class);
65         }
66         public void error(final String JavaDoc message, final URL JavaDoc url, final int line, final int column, final String JavaDoc key)
67         {
68             getLog().error(format(message, url, line, column, key));
69         }
70         public void warning(final String JavaDoc message, final URL JavaDoc url, final int line, final int column, final String JavaDoc key)
71         {
72             getLog().warn(format(message, url, line, column, key));
73         }
74         private String JavaDoc format(final String JavaDoc message, final URL JavaDoc url, final int line, final int column, final String JavaDoc key) {
75             final StringBuffer JavaDoc buffer = new StringBuffer JavaDoc(message);
76             buffer.append(" (");
77             buffer.append(url.toExternalForm());
78             buffer.append(" ");
79             buffer.append(line);
80             buffer.append(":");
81             buffer.append(column);
82             buffer.append(")");
83             return buffer.toString();
84         }
85     };
86
87     /**
88      * Called when the html parser reports an error.
89      * @param message the description of the problem
90      * @param url the url of the document in which the problem occurs
91      * @param line the line of the problem
92      * @param column the column of the problem
93      * @param key the key identifying the "type" of problem. May be interesting to filter messages.
94      */
95     void error(final String JavaDoc message, final URL JavaDoc url, final int line, final int column, final String JavaDoc key);
96     
97     /**
98      * Called when the html parser reports a warning.
99      * @param message the description of the problem
100      * @param url the url of the document in which the problem occurs
101      * @param line the line of the problem
102      * @param column the column of the problem
103      * @param key the key identifying the "type" of problem. May be interesting to filter messages.
104      */
105     void warning(final String JavaDoc message, final URL JavaDoc url, final int line, final int column, final String JavaDoc key);
106 }
107
Popular Tags