1 package org.codehaus.plexus.compiler;
2
3 /**
4 * The MIT License
5 *
6 * Copyright (c) 2004, The Codehaus
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy of
9 * this software and associated documentation files (the "Software"), to deal in
10 * the Software without restriction, including without limitation the rights to
11 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12 * of the Software, and to permit persons to whom the Software is furnished to do
13 * so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in all
16 * copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27 /**
28 * The interface of an compiling language processor (aka compiler).
29 *
30 * @author <a href="mailto:jason@plexus.org">Jason van Zyl</a>
31 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
32 * @author <a href="mailto:matthew.pocock@ncl.ac.uk">Matthew Pocock</a>
33 */
34 public interface Compiler {
35 String ROLE = Compiler.class.getName();
36
37 CompilerOutputStyle getCompilerOutputStyle();
38
39 String getInputFileEnding(CompilerConfiguration configuration) throws CompilerException;
40
41 String getOutputFileEnding(CompilerConfiguration configuration) throws CompilerException;
42
43 String getOutputFile(CompilerConfiguration configuration) throws CompilerException;
44
45 boolean canUpdateTarget(CompilerConfiguration configuration) throws CompilerException;
46
47 /**
48 * Performs the compilation of the project. Clients must implement this
49 * method.
50 *
51 * @param configuration the configuration description of the compilation
52 * to perform
53 * @return the result of the compilation returned by the language processor
54 * @throws CompilerException
55 */
56 CompilerResult performCompile(CompilerConfiguration configuration) throws CompilerException;
57
58 /**
59 * Create the command line that would be executed using this configuration.
60 * If this particular compiler has no concept of a command line then returns
61 * null.
62 *
63 * @param config the CompilerConfiguration describing the compilation
64 * @return an array of Strings that make up the command line, or null if
65 * this compiler has no concept of command line
66 * @throws CompilerException if there was an error generating the command
67 * line
68 */
69 String[] createCommandLine(CompilerConfiguration config) throws CompilerException;
70
71 /**
72 * Based on this flag the caller can decide the strategy how to compile. E.g. is incrementCompilation is not supported,
73 * it could decide to clear to outputDirectory to enforce a complete recompilation.
74 *
75 * @return {@code true} if incrementalCompilation is supported, otherwise {@code false}
76 */
77 default boolean supportsIncrementalCompilation() {
78 return false;
79 }
80 }