1 package org.apache.torque.task;
2
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
22 import org.apache.velocity.context.Context;
23
24 /**
25 * An ant task for generating output by using Velocity
26 *
27 * @author <a href="mailto:mpoeschl@marmot.at">Martin Poeschl</a>
28 * @version $Id: TorqueDocumentationTask.java,v 1.1 2007-10-21 07:57:26 abyrne Exp $
29 */
30 public class TorqueDocumentationTask extends TorqueDataModelTask
31 {
32 /** output format for the generated docs */
33 private String outputFormat;
34
35 /**
36 * Get the current output format.
37 *
38 * @return the current output format
39 */
40 public String getOutputFormat()
41 {
42 return outputFormat;
43 }
44
45 /**
46 * Set the current output format.
47 *
48 * @param v output format
49 */
50 public void setOutputFormat(String v)
51 {
52 outputFormat = v;
53 }
54
55 /**
56 * Place our target package value into the context for use in the templates.
57 *
58 * @return the context
59 * @throws Exception a generic exception
60 */
61 public Context initControlContext() throws Exception
62 {
63 super.initControlContext();
64 context.put("outputFormat", outputFormat);
65 context.put("escape", new org.apache.velocity.anakia.Escape());
66 return context;
67 }
68 }