1 package org.apache.torque.generator.configuration.paths;
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 /**
23 * The paths describing the internal organization (i.e. file paths)
24 * of the Torque generator files.
25 */
26 public interface TorqueGeneratorPaths
27 {
28 /**
29 * Returns the path to the file containing the control configuration,
30 * relative to the configuration directory.
31 *
32 * @return the path to the control configuration file, not null.
33 */
34 String getControlConfigurationFile();
35
36 /**
37 * Returns the path to the directory containing the templates,
38 * relative to the torque-gen directory.
39 *
40 * @return the path to the template directory. not null.
41 */
42 String getTemplateDirectory();
43
44 /**
45 * Returns the path to the directory containing the configuration,
46 * relative to the torque-gen directory.
47 *
48 * @return the path to the configuration directory. not null.
49 */
50 String getConfigurationDirectory();
51
52 /**
53 * Returns the path to the directory containing the outlet definitions,
54 * relative to the Torque generator configuration directory.
55 *
56 * @return the path to the outlet definition directory, not null.
57 */
58 String getOutletDirectory();
59
60 /**
61 * Returns the path to the directory containing the resources,
62 * relative to the Torque generator configuration directory.
63 *
64 * @return the path to the resources directory, not null.
65 */
66 String getResourceDirectory();
67 }