Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java@998b10c43157 (annotated)
src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java
Tue, 24 Dec 2013 09:17:37 -0800
- author
- ksrini
- date
- Tue, 24 Dec 2013 09:17:37 -0800
- changeset 2227
- 998b10c43157
- parent 1359
- 25e14ad23cef
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com
| duke@1 | 1 | /* |
| jjg@1359 | 2 | * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.javadoc; |
| duke@1 | 27 | |
| jjg@197 | 28 | import java.util.EnumSet; |
| jjg@197 | 29 | import javax.tools.JavaFileObject; |
| jjg@197 | 30 | |
| duke@1 | 31 | import com.sun.tools.javac.code.Symbol.PackageSymbol; |
| duke@1 | 32 | import com.sun.tools.javac.jvm.ClassReader; |
| duke@1 | 33 | import com.sun.tools.javac.util.Context; |
| duke@1 | 34 | |
| duke@1 | 35 | /** Javadoc uses an extended class reader that records package.html entries |
| jjg@1359 | 36 | * |
| jjg@1359 | 37 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 38 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 39 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 40 | * deletion without notice.</b> |
| jjg@1359 | 41 | * |
| duke@1 | 42 | * @author Neal Gafter |
| duke@1 | 43 | */ |
| ksrini@1051 | 44 | public class JavadocClassReader extends ClassReader { |
| duke@1 | 45 | |
| duke@1 | 46 | public static JavadocClassReader instance0(Context context) { |
| duke@1 | 47 | ClassReader instance = context.get(classReaderKey); |
| duke@1 | 48 | if (instance == null) |
| duke@1 | 49 | instance = new JavadocClassReader(context); |
| duke@1 | 50 | return (JavadocClassReader)instance; |
| duke@1 | 51 | } |
| duke@1 | 52 | |
| jjg@893 | 53 | public static void preRegister(Context context) { |
| duke@1 | 54 | context.put(classReaderKey, new Context.Factory<ClassReader>() { |
| jjg@893 | 55 | public ClassReader make(Context c) { |
| jjg@893 | 56 | return new JavadocClassReader(c); |
| duke@1 | 57 | } |
| duke@1 | 58 | }); |
| duke@1 | 59 | } |
| duke@1 | 60 | |
| duke@1 | 61 | private DocEnv docenv; |
| duke@1 | 62 | private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS, |
| duke@1 | 63 | JavaFileObject.Kind.SOURCE, |
| duke@1 | 64 | JavaFileObject.Kind.HTML); |
| duke@1 | 65 | private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS, |
| duke@1 | 66 | JavaFileObject.Kind.HTML); |
| duke@1 | 67 | |
| ksrini@1051 | 68 | public JavadocClassReader(Context context) { |
| duke@1 | 69 | super(context, true); |
| duke@1 | 70 | docenv = DocEnv.instance(context); |
| jjg@754 | 71 | preferSource = true; |
| duke@1 | 72 | } |
| duke@1 | 73 | |
| duke@1 | 74 | /** |
| duke@1 | 75 | * Override getPackageFileKinds to include search for package.html |
| duke@1 | 76 | */ |
| duke@1 | 77 | @Override |
| duke@1 | 78 | protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() { |
| duke@1 | 79 | return docenv.docClasses ? noSource : all; |
| duke@1 | 80 | } |
| duke@1 | 81 | |
| duke@1 | 82 | /** |
| duke@1 | 83 | * Override extraFileActions to check for package documentation |
| duke@1 | 84 | */ |
| duke@1 | 85 | @Override |
| duke@1 | 86 | protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) { |
| jjg@197 | 87 | if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML)) |
| jjg@197 | 88 | docenv.getPackageDoc(pack).setDocPath(fo); |
| duke@1 | 89 | } |
| duke@1 | 90 | } |
