This project has retired. For details please refer to its Attic page.
VelocityTemplateGeneratorFactory xref
View Javadoc

1   /*
2    * $Id: VelocityTemplateGeneratorFactory.java 1643653 2014-12-07 06:47:59Z nlebas $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.tiles.autotag.velocity;
22  
23  import org.apache.tiles.autotag.core.OutputLocator;
24  import org.apache.tiles.autotag.generate.TemplateGenerator;
25  import org.apache.tiles.autotag.generate.TemplateGeneratorBuilder;
26  import org.apache.tiles.autotag.generate.TemplateGeneratorFactory;
27  import org.apache.velocity.app.VelocityEngine;
28  
29  /**
30   * Creates a template generator that generates code to build Velocity code
31   * around template classes.
32   *
33   * @version $Rev: 1643653 $ $Date: 2014-12-07 07:47:59 +0100 (Sun, 07 Dec 2014) $
34   */
35  public class VelocityTemplateGeneratorFactory implements
36          TemplateGeneratorFactory {
37  
38      /**
39       * Location of the file.
40       */
41      private OutputLocator classesOutputLocator;
42  
43      /**
44       * Location of the file.
45       */
46      private OutputLocator resourcesOutputLocator;
47  
48      /**
49       * The Velocity engine.
50       */
51      private VelocityEngine velocityEngine;
52  
53      /**
54       * The template generator builder.
55       */
56      private TemplateGeneratorBuilder templateGeneratorBuilder;
57  
58      /**
59       * Constructor.
60       *
61       * @param classesOutputLocator The directory where classes will be generated.
62       * @param resourcesOutputLocator The directory where velocity.properties will be written.
63       * @param velocityEngine The Velocity engine.
64       * @param templateGeneratorBuilder The template generator builder.
65       */
66      public VelocityTemplateGeneratorFactory(OutputLocator classesOutputLocator,
67      		OutputLocator resourcesOutputLocator, VelocityEngine velocityEngine,
68              TemplateGeneratorBuilder templateGeneratorBuilder) {
69          this.classesOutputLocator = classesOutputLocator;
70          this.resourcesOutputLocator = resourcesOutputLocator;
71          this.velocityEngine = velocityEngine;
72          this.templateGeneratorBuilder = templateGeneratorBuilder;
73      }
74  
75      @Override
76      public TemplateGenerator createTemplateGenerator() {
77          return templateGeneratorBuilder
78                  .setClassesOutputLocator(classesOutputLocator)
79                  .setResourcesOutputLocator(resourcesOutputLocator)
80                  .addResourcesTemplateSuiteGenerator(
81                          new VelocityPropertiesGenerator(velocityEngine))
82                  .addClassesTemplateClassGenerator(
83                          new VelocityDirectiveGenerator(velocityEngine)).build();
84      }
85  
86  }