1 package org.apache.torque.generator.control.action;
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.GeneratorException;
23 import org.apache.torque.generator.control.ControllerState;
24 import org.apache.torque.generator.outlet.OutletResult;
25
26 /**
27 * An action which can be executed in a mergepoint.
28 */
29 public interface MergepointAction
30 {
31 /**
32 * Executes the action.
33 *
34 * @param controllerState The current state of the controller.
35 *
36 * @return The value to insert into the mergepoint, not null.
37 *
38 * @throws GeneratorException if an error occurs during generation.
39 */
40 OutletResult execute(ControllerState controllerState)
41 throws GeneratorException;
42
43 }