View Javadoc

1   /*
2    * Copyright 2006 Outsource Cafe, Inc.
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.javagen.agile.core;
17  
18  import org.javagen.agile.core.model.Model;
19  
20  /***
21   * The generator is the basis for task-specific, decoupled, units of work in the JavaGen Light code generator.  
22   * Generators are configured sequentially in the <code>GeneratorPipeline</code>, forming a code generation assembly line.
23   *
24   * @author Richard Easterling
25   */
26  public interface Generator {
27  	
28      /***
29       * Entry point for generation task.
30       * 
31       * @param input the model instance to generate on - parent nodes will be ignored.   
32       * @return the result of the task - usualy the same as the input model.
33       */
34  	Model gen(Model input);
35  	
36  }