1 package org.apache.torque.generator.source;
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 java.io.File;
23
24 /**
25 * An entity which serves as an input for the generation process.
26 */
27 public interface Source
28 {
29 /**
30 * Returns the root element of the source.
31 *
32 * @return the root element of the source, not null.
33 *
34 * @throws SourceException if the source cannot be constructed.
35 */
36 SourceElement getRootElement() throws SourceException;
37
38 /**
39 * Gets a description of this source for debugging purposes.
40 *
41 * @return the description, which should make it possible to identify
42 * the currently processed output.
43 */
44 String getDescription();
45
46 /**
47 * Returns the source file, if it exists.
48 *
49 * @return the source file, or null if the source is not read from a file.
50 * @return
51 */
52 File getSourceFile();
53 }