aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/java_tools/buildjar/java/com/google/devtools/build/buildjar/javac/JavacRunner.java
blob: 6cd4b9abe3e3e597bd5c26a9eaddc746f77c7222 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
// Copyright 2014 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.buildjar.javac;

import com.sun.tools.javac.main.Main.Result;

import java.io.PrintWriter;

/**
 * The JavacRunner is a type that can be used to invoke
 * javac and provides a convenient hook for modifications.
 * It is split in two parts: An interface "JavacRunner" and
 * an implementation of that interface, "JavacRunnerImpl".
 *
 * The type is split in two parts to allow us to load
 * the implementation multiple times in different classloaders.
 * This is neccessary, as a single javac can not run multiple
 * times in parallel. By using different classloaders to load
 * different copies of javac in different JavacRunnerImpls,
 * we can run them in parallel.
 *
 * However, since each JavacRunnerImpl will then be loaded
 * in a different classloader, we then would not be able to
 * refer to it by simply declaring a type as "JavacRunnerImpl",
 * as this refers to the JavacRunnerImpl type loaded with the
 * default classloader. Therefore, we'd have to address each
 * of the different JavacRunnerImpls as "Object" and invoke
 * its method via reflection.
 *
 * We can circumvent this problem by declaring an interface
 * that JavacRunnerImpl implements (i.e. JavacRunner).
 * If we always load this super-interface in the default
 * classloader, and make each JavacRunnerImpl (loaded in its
 * own classloader) implement it, we can refer to the
 * JavacRunnerImpls as "JavacRunner"s in the main program.
 * That way, we can avoid using reflection and "Object"
 * to deal with the different JavacRunnerImpls.
 */
public interface JavacRunner {

  Result invokeJavac(String[] args, PrintWriter output);

}