1 package org.apache.torque.generator.source.skipDecider;
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.SourceException;
24
25 /**
26 * A class deciding whether the generation should be skipped or not.
27 * The class is asked for every source which is processed.
28 *
29 * @version $Id: SkipDecider.java 1331190 2012-04-27 02:41:35Z tfischer $
30 */
31 public interface SkipDecider
32 {
33 /**
34 * Decides whether the source file should be skipped and not used for
35 * generation.
36 * @param controllerState the current controller state, containing e.g.
37 * the current source element.
38 * @return true if the current generation should proceed,
39 * false if the generation should be skipped.
40 *
41 * @throws SourceException if an error occurs
42 */
43 boolean proceed(ControllerState controllerState) throws SourceException;
44 }