01: package org.apache.torque.task;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "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 473814 2006-11-11 22:30:30Z tv $
29: */
30: public class TorqueDocumentationTask extends TorqueDataModelTask {
31: /** output format for the generated docs */
32: private String outputFormat;
33:
34: /**
35: * Get the current output format.
36: *
37: * @return the current output format
38: */
39: public String getOutputFormat() {
40: return outputFormat;
41: }
42:
43: /**
44: * Set the current output format.
45: *
46: * @param v output format
47: */
48: public void setOutputFormat(String v) {
49: outputFormat = v;
50: }
51:
52: /**
53: * Place our target package value into the context for use in the templates.
54: *
55: * @return the context
56: * @throws Exception a generic exception
57: */
58: public Context initControlContext() throws Exception {
59: super .initControlContext();
60: context.put("outputFormat", outputFormat);
61: context.put("escape", new org.apache.velocity.anakia.Escape());
62: return context;
63: }
64: }
|