JavadocClassFinder.java revision 3827:44bdefe64114 
1/*
2 * Copyright (c) 2001, 2014, 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 com.sun.tools.javadoc.main;
27
28import java.util.EnumSet;
29import javax.tools.JavaFileObject;
30
31import com.sun.tools.javac.code.Symbol.PackageSymbol;
32import com.sun.tools.javac.code.ClassFinder;
33import com.sun.tools.javac.util.Context;
34import com.sun.tools.javac.util.Context.Factory;
35
36/** Javadoc uses an extended class finder that records package.html entries
37 *
38 *  <p><b>This is NOT part of any supported API.
39 *  If you write code that depends on this, you do so at your own risk.
40 *  This code and its internal interfaces are subject to change or
41 *  deletion without notice.</b>
42 *
43 *  @author Neal Gafter
44 */
45@Deprecated
46public class JavadocClassFinder extends ClassFinder {
47
48    public static JavadocClassFinder instance(Context context) {
49        ClassFinder instance = context.get(classFinderKey);
50        if (instance == null)
51            instance = new JavadocClassFinder(context);
52        return (JavadocClassFinder)instance;
53    }
54
55    public static void preRegister(Context context) {
56        context.put(classFinderKey, (Factory<ClassFinder>)JavadocClassFinder::new);
57    }
58
59    private DocEnv docenv;
60    private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS,
61                                                          JavaFileObject.Kind.SOURCE,
62                                                          JavaFileObject.Kind.HTML);
63    private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS,
64                                                               JavaFileObject.Kind.HTML);
65
66    public JavadocClassFinder(Context context) {
67        super(context);
68        docenv = DocEnv.instance(context);
69        preferSource = true;
70    }
71
72    /**
73     * Override getPackageFileKinds to include search for package.html
74     */
75    @Override
76    protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() {
77        return docenv.docClasses ? noSource : all;
78    }
79
80    /**
81     * Override extraFileActions to check for package documentation
82     */
83    @Override
84    protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) {
85        if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML))
86            docenv.getPackageDoc(pack).setDocPath(fo);
87    }
88}
89