1 package org.apache.torque.generator.source.transform;
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.torque.generator.control.ControllerState;
23 import org.apache.torque.generator.source.SourceElement;
24
25 /**
26 * Transforms one source tree into another source tree.
27 */
28 public interface SourceTransformer
29 {
30 /**
31 * Transforms one source tree into another source tree.
32 * It is allowed to modify the toTransformRoot tree and
33 * return the same tree.
34 *
35 * @param toTransformRoot the root element of the source tree
36 * to transform, not null.
37 * @param controllerState the state of the controller, not null.
38 *
39 * @return the root element of the transformed source tree, not null.
40 *
41 * @throws SourceTransformerException if the source cannot be transformed.
42 */
43 SourceElement transform(
44 SourceElement toTransformRoot,
45 ControllerState controllerState)
46 throws SourceTransformerException;
47 }