jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java@c75be5bc5283

     1 /*

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

    26 package com.sun.tools.javadoc;

    28 import java.util.EnumSet;

    29 import javax.tools.JavaFileObject;

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

    32 import com.sun.tools.javac.jvm.ClassReader;

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

    35 /** Javadoc uses an extended class reader that records package.html entries

    36  *  @author Neal Gafter

    37  */

    38 public class JavadocClassReader extends ClassReader {

    40     public static JavadocClassReader instance0(Context context) {

    41         ClassReader instance = context.get(classReaderKey);

    42         if (instance == null)

    43             instance = new JavadocClassReader(context);

    44         return (JavadocClassReader)instance;

    45     }

    47     public static void preRegister(Context context) {

    48         context.put(classReaderKey, new Context.Factory<ClassReader>() {

    49             public ClassReader make(Context c) {

    50                 return new JavadocClassReader(c);

    51             }

    52         });

    53     }

    55     private DocEnv docenv;

    56     private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS,

    57                                                           JavaFileObject.Kind.SOURCE,

    58                                                           JavaFileObject.Kind.HTML);

    59     private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS,

    60                                                                JavaFileObject.Kind.HTML);

    62     public JavadocClassReader(Context context) {

    63         super(context, true);

    64         docenv = DocEnv.instance(context);

    65         preferSource = true;

    66     }

    68     /**

    69      * Override getPackageFileKinds to include search for package.html

    70      */

    71     @Override

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

    73         return docenv.docClasses ? noSource : all;

    74     }

    76     /**

    77      * Override extraFileActions to check for package documentation

    78      */

    79     @Override

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

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

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

    83     }

    84 }

Mercurial > jdk8-mips64-public > langtools / file revision