01: /*BEGIN_COPYRIGHT_BLOCK
02: *
03: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
04: * All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions are met:
08: * * Redistributions of source code must retain the above copyright
09: * notice, this list of conditions and the following disclaimer.
10: * * Redistributions in binary form must reproduce the above copyright
11: * notice, this list of conditions and the following disclaimer in the
12: * documentation and/or other materials provided with the distribution.
13: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
14: * names of its contributors may be used to endorse or promote products
15: * derived from this software without specific prior written permission.
16: *
17: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: *
29: * This software is Open Source Initiative approved Open Source Software.
30: * Open Source Initative Approved is a trademark of the Open Source Initiative.
31: *
32: * This file is part of DrJava. Download the current version of this project
33: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
34: *
35: * END_COPYRIGHT_BLOCK*/
36:
37: package edu.rice.cs.drjava.model.compiler;
38:
39: import java.io.File;
40: import java.util.List;
41: import edu.rice.cs.plt.reflect.JavaVersion;
42:
43: /** The minimum interface that a compiler must meet to be used by DrJava.
44: * @version $Id: CompilerInterface.java 4255 2007-08-28 19:17:37Z mgricken $
45: */
46: public interface CompilerInterface {
47:
48: /** Indicates whether this compiler is actually available. As in: Is it installed and located? This method
49: * should load the compiler class, which should hopefully prove whether the class can load. If this
50: * method returns true, the {@link #compile} method should not fail due to class not being found.
51: */
52: boolean isAvailable();
53:
54: /** Compile the given files.
55: * @param files Source files to compile.
56: * @param classPath Support jars or directories that should be on the classpath. If @code{null}, the default is used.
57: * @param sourcePath Location of additional sources to be compiled on-demand. If @code{null}, the default is used.
58: * @param destination Location (directory) for compiled classes. If @code{null}, the default in-place location is used.
59: * @param bootClassPath The bootclasspath (contains Java API jars or directories); should be consistent with @code{sourceVersion}
60: * If @code{null}, the default is used.
61: * @param sourceVersion The language version of the sources. Should be consistent with @code{bootClassPath}. If @code{null},
62: * the default is used.
63: * @param showWarnings Whether compiler warnings should be shown or ignored.
64: * @return Errors that occurred. If no errors, should be zero length (not null).
65: */
66: List<? extends CompilerError> compile(List<? extends File> files,
67: List<? extends File> classPath,
68: List<? extends File> sourcePath, File destination,
69: List<? extends File> bootClassPath, String sourceVersion,
70: boolean showWarnings);
71:
72: /** The latest version of Java supported by the compiler */
73: JavaVersion version();
74:
75: /** Returns the name of this compiler, appropriate to show to the user. */
76: String getName();
77:
78: /** Returns a one-line description of the compiler (such as the name and file location) */
79: String getDescription();
80:
81: /** String to display in a combo box (generally {@code getName()}) */
82: String toString();
83:
84: }
|