KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > components > language > markup > MarkupCodeGenerator


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.components.language.markup;
17
18 import org.apache.excalibur.source.Source;
19 import org.apache.cocoon.xml.AbstractXMLPipe;
20
21 /**
22  * This interfaces defines the functionality of a source code generator
23  *
24  * @author <a HREF="mailto:ricardo@apache.org">Ricardo Rocha</a>
25  * @author <a HREF="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
26  * @version CVS $Id: MarkupCodeGenerator.java 30932 2004-07-29 17:35:38Z vgritsenko $
27  */
28 public interface MarkupCodeGenerator {
29
30     /**
31      * Generate source code from the given markup source.
32      * Start and end specify SAX pre processing pipeline.
33      *
34      * @param source The source of the markup program
35      * @param filter Pre-processing SAX filter
36      * @return The generated source code
37      * @exception Exception If an error occurs during code generation
38      */
39     String JavaDoc generateCode(Source source, AbstractXMLPipe filter)
40         throws Exception JavaDoc;
41 }
42
Popular Tags