KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > generation > Generator


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.generation;
17
18 import org.apache.cocoon.ProcessingException;
19 import org.apache.cocoon.sitemap.SitemapModelComponent;
20 import org.apache.cocoon.xml.XMLProducer;
21 import org.xml.sax.SAXException JavaDoc;
22
23 import java.io.IOException JavaDoc;
24
25 /**
26  * A generator is the starting point of a pipeline. It "generates" XML
27  * and starts streaming them into the pipeline.
28  *
29  * @author <a HREF="mailto:pier@apache.org">Pierpaolo Fumagalli</a>
30  * (Apache Software Foundation)
31  * @version CVS $Id: Generator.java 30932 2004-07-29 17:35:38Z vgritsenko $
32  */
33 public interface Generator extends XMLProducer, SitemapModelComponent {
34
35     String JavaDoc ROLE = Generator.class.getName();
36
37     /**
38      * Generate the XML and stream it into the pipeline
39      */
40     void generate()
41     throws IOException JavaDoc, SAXException JavaDoc, ProcessingException;
42 }
43
Popular Tags