View Javadoc
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  import java.util.List;
28  
29  /**
30   * The interface of an compiling language processor (aka compiler).
31   * 
32   * @author <a href="mailto:jason@plexus.org">Jason van Zyl</a>
33   * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
34   * @author <a href="mailto:matthew.pocock@ncl.ac.uk">Matthew Pocock</a>
35   */
36  public interface Compiler
37  {
38      String ROLE = Compiler.class.getName();
39  
40      CompilerOutputStyle getCompilerOutputStyle();
41  
42      String getInputFileEnding( CompilerConfiguration configuration )
43          throws CompilerException;
44  
45      String getOutputFileEnding( CompilerConfiguration configuration )
46          throws CompilerException;
47  
48      String getOutputFile( CompilerConfiguration configuration )
49          throws CompilerException;
50  
51      boolean canUpdateTarget( CompilerConfiguration configuration )
52          throws CompilerException;
53  
54      /**
55       * Performs the compilation of the project. Clients must implement this
56       * method.
57       * 
58       * @param configuration   the configuration description of the compilation
59       *   to perform
60       * @return the result of the compilation returned by the language processor
61       * @throws CompilerException
62       */
63      CompilerResult performCompile( CompilerConfiguration configuration )
64          throws CompilerException;
65  
66      /**
67       * This method is provided for backwards compatibility only. Clients should
68       * use {@link #performCompile(CompilerConfiguration)} instead.
69       * 
70       * @param configuration   the configuration description of the compilation
71       *   to perform
72       * @return the result of the compilation returned by the language processor
73       * @throws CompilerException
74       */
75      @Deprecated
76      List<CompilerError> compile( CompilerConfiguration configuration )
77              throws CompilerException;
78      
79      /**
80       * Create the command line that would be executed using this configuration.
81       * If this particular compiler has no concept of a command line then returns
82       * null.
83       *
84       * @param config     the CompilerConfiguration describing the compilation
85       * @return an array of Strings that make up the command line, or null if
86       *   this compiler has no concept of command line
87       * @throws CompilerException  if there was an error generating the command
88       *   line
89       */
90      String[] createCommandLine( CompilerConfiguration config )
91          throws CompilerException;
92  }