1 /*

     2  * Copyright (c) 2001, 2018, 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 

    26 package com.sun.tools.javadoc.main;

    27 

    28 import java.util.EnumSet;

    29 import javax.tools.JavaFileObject;

    30 

    31 import com.sun.tools.javac.code.Symbol.PackageSymbol;

    32 import com.sun.tools.javac.code.ClassFinder;

    33 import com.sun.tools.javac.util.Context;

    34 import 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(since="9", forRemoval=true)

    46 @SuppressWarnings("removal")

    47 public 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 DocEnv docenv;

    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 

    67     public JavadocClassFinder(Context context) {

    68         super(context);

    69         docenv = DocEnv.instance(context);

    70         preferSource = true;

    71     }

    72 

    73     /**

    74      * Override getPackageFileKinds to include search for package.html

    75      */

    76     @Override

    77     protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() {

    78         return docenv.docClasses ? noSource : all;

    79     }

    80 

    81     /**

    82      * Override extraFileActions to check for package documentation

    83      */

    84     @Override

    85     protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) {

    86         if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML))

    87             docenv.getPackageDoc(pack).setDocPath(fo);

    88     }

    89 }