01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
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: * Parses a document from the reader, without actually rewriting URLs.
32: * During parsing the events are called back on the given rewriter to handle the normalized events.
33: *
34: * @param reader the input stream over the content to be parsed.
35: * @exception RewriteException when a parsing error occurs or unexpected content is found.
36: */
37: void parse(Rewriter rewriter, Reader reader)
38: throws RewriterException;
39:
40: /**
41: * Parses and rewrites a document from the reader, rewriting URLs via the rewriter's events to the writer.
42: * During parsing the rewriter events are called on the given rewriter to handle the rewriting.
43: *
44: * @param reader the input stream over the content to be parsed.
45: * @param writer the output stream where content is rewritten to.
46: * @exception RewriteException when a parsing error occurs or unexpected content is found.
47: */
48: void rewrite(Rewriter rewriter, Reader reader, Writer writer)
49: throws RewriterException;
50:
51: }
|