JavadocClassFinder.java revision 3827:44bdefe64114 
1/*
2 * Copyright (c) 2001, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package jdk.javadoc.internal.tool;
27
28import java.util.EnumSet;
29
30import javax.tools.JavaFileObject;
31
32import com.sun.tools.javac.api.JavacTrees;
33import com.sun.tools.javac.code.Symbol.PackageSymbol;
34import com.sun.tools.javac.code.ClassFinder;
35import com.sun.tools.javac.util.Context;
36import com.sun.tools.javac.util.Context.Factory;
37
38/** Javadoc uses an extended class finder that records package.html entries
39 *
40 *  <p><b>This is NOT part of any supported API.
41 *  If you write code that depends on this, you do so at your own risk.
42 *  This code and its internal interfaces are subject to change or
43 *  deletion without notice.</b>
44 *
45 *  @author Neal Gafter
46 */
47public class JavadocClassFinder extends ClassFinder {
48
49    public static JavadocClassFinder instance(Context context) {
50        ClassFinder instance = context.get(classFinderKey);
51        if (instance == null)
52            instance = new JavadocClassFinder(context);
53        return (JavadocClassFinder)instance;
54    }
55
56    public static void preRegister(Context context) {
57        context.put(classFinderKey, (Factory<ClassFinder>)JavadocClassFinder::new);
58    }
59
60    private ToolEnvironment toolEnv;
61    private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS,
62                                                          JavaFileObject.Kind.SOURCE,
63                                                          JavaFileObject.Kind.HTML);
64    private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS,
65                                                               JavaFileObject.Kind.HTML);
66    private JavacTrees jctrees;
67
68    private final JavacTrees trees;
69
70    public JavadocClassFinder(Context context) {
71        super(context);
72        toolEnv = ToolEnvironment.instance(context);
73        preferSource = true;
74        trees = JavacTrees.instance(context);
75    }
76
77    /**
78     * Override getPackageFileKinds to include search for package.html
79     */
80    @Override
81    protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() {
82        return toolEnv.docClasses ? noSource : all;
83    }
84
85    /**
86     * Override extraFileActions to check for package documentation
87     */
88    @Override
89    protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) {
90        if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML)) {
91            toolEnv.pkgToJavaFOMap.put(pack, fo);
92            trees.putJavaFileObject(pack, fo);
93        }
94    }
95}
96