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.cocoon.components.language.markup;
18:
19: import org.apache.excalibur.source.Source;
20: import org.apache.cocoon.xml.AbstractXMLPipe;
21:
22: /**
23: * This interfaces defines the functionality of a source code generator
24: *
25: * @author <a href="mailto:ricardo@apache.org">Ricardo Rocha</a>
26: * @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
27: * @version CVS $Id: MarkupCodeGenerator.java 433543 2006-08-22 06:22:54Z crossley $
28: */
29: public interface MarkupCodeGenerator {
30:
31: /**
32: * Generate source code from the given markup source.
33: * Start and end specify SAX pre processing pipeline.
34: *
35: * @param source The source of the markup program
36: * @param filter Pre-processing SAX filter
37: * @return The generated source code
38: * @exception Exception If an error occurs during code generation
39: */
40: String generateCode(Source source, AbstractXMLPipe filter)
41: throws Exception;
42: }
|