1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.jetspeed.rewriter;
18
19 import java.io.Reader;
20 import java.io.Writer;
21
22 /***
23 * Interface for HTML Parser Adaptors.
24 * Adaptors normalize the interface over HTML and XML adaptor implementations.
25 *
26 * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
27 * @version $Id: ParserAdaptor.java 516448 2007-03-09 16:25:47Z ate $
28 */
29 public interface ParserAdaptor
30 {
31 /***
32 * Parses a document from the reader, without actually rewriting URLs.
33 * During parsing the events are called back on the given rewriter to handle the normalized events.
34 *
35 * @param reader the input stream over the content to be parsed.
36 * @exception RewriteException when a parsing error occurs or unexpected content is found.
37 */
38 void parse(Rewriter rewriter, Reader reader)
39 throws RewriterException;
40
41 /***
42 * Parses and rewrites a document from the reader, rewriting URLs via the rewriter's events to the writer.
43 * During parsing the rewriter events are called on the given rewriter to handle the rewriting.
44 *
45 * @param reader the input stream over the content to be parsed.
46 * @param writer the output stream where content is rewritten to.
47 * @exception RewriteException when a parsing error occurs or unexpected content is found.
48 */
49 void rewrite(Rewriter rewriter, Reader reader, Writer writer)
50 throws RewriterException;
51
52 }