CompilerInterface


1   /*BEGIN_COPYRIGHT_BLOCK
2    *
3    * This file is part of DrJava.  Download the current version of this project from http://www.drjava.org/
4    * or http://sourceforge.net/projects/drjava/
5    *
6    * DrJava Open Source License
7    * 
8    * Copyright (C) 2001-2005 JavaPLT group at Rice University (javaplt@rice.edu).  All rights reserved.
9    *
10   * Developed by:   Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11   * 
12   * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
13   * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14   * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
15   * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16   * 
17   *     - Redistributions of source code must retain the above copyright notice, this list of conditions and the 
18   *       following disclaimers.
19   *     - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the 
20   *       following disclaimers in the documentation and/or other materials provided with the distribution.
21   *     - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to 
22   *       endorse or promote products derived from this Software without specific prior written permission.
23   *     - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their 
24   *       names without prior written permission from the JavaPLT group.  For permission, write to javaplt@rice.edu.
25   * 
26   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO 
27   * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
28   * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
29   * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
30   * WITH THE SOFTWARE.
31   * 
32  END_COPYRIGHT_BLOCK*/
33  
34  package edu.rice.cs.drjava.model.compiler;
35  
36  import  java.io.File  ;
37  import java.util.List  ;
38  
39  /** The minimum interface that a compiler must meet to be used by DrJava.
40   *  @version $Id: CompilerInterface.java 4044 2006-11-23 13:40:43Z dlsmith $
41   */
42  public interface CompilerInterface {
43    
44    /** Compile the given files.
45     *  @param files  Source files to compile.
46     *  @param classPath  Support jars or directories that should be on the classpath.  If @code{null}, the default is used.
47     *  @param sourcePath  Location of additional sources to be compiled on-demand.  If @code{null}, the default is used.
48     *  @param destination  Location (directory) for compiled classes.  If @code{null}, the default in-place location is used.
49     *  @param bootClassPath  The bootclasspath (contains Java API jars or directories); should be consistent with @code{sourceVersion} 
50     *                        If @code{null}, the default is used.
51     *  @param sourceVersion  The language version of the sources.  Should be consistent with @code{bootClassPath}.  If @code{null},
52     *                        the default is used.
53     *  @param showWarnings  Whether compiler warnings should be shown or ignored.
54     *  @return Errors that occurred. If no errors, should be zero length (not null).
55     */
56    List  <? extends CompilerError> compile(List  <? extends File  > files, List  <? extends File  > classPath, 
57                                          List  <? extends File  > sourcePath, File   destination, 
58                                          List  <? extends File  > bootClassPath, String   sourceVersion, boolean showWarnings);
59    
60    /** Indicates whether this compiler is actually available. As in: Is it installed and located? This method 
61     *  should load the compiler class, which should hopefully prove whether the class can load.  If this 
62     *  method returns true, the {@link #compile} method should not fail due to class not being found.
63     */
64    boolean isAvailable();
65  
66    /** Returns the name of this compiler, appropriate to show to the user. */
67    String   getName();
68  
69    /** Should return info about compiler, at least including name. */
70    String   toString();
71    
72  }
73
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags