Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java@1bf037016426 (annotated)
src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java
Tue, 20 Jan 2009 15:17:45 -0800
- author
- jjg
- date
- Tue, 20 Jan 2009 15:17:45 -0800
- changeset 197
- 1bf037016426
- parent 62
- 07c916ecfc71
- child 229
- 03bcd66bd8e7
- permissions
- -rw-r--r--
6794582: javadoc should read files using a FileManager
Reviewed-by: darcy, bpatel
| duke@1 | 1 | /* |
| xdono@54 | 2 | * Copyright 2001-2008 Sun Microsystems, Inc. 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 |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun 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 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any 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 |
| duke@1 | 36 | * @author Neal Gafter |
| duke@1 | 37 | */ |
| duke@1 | 38 | class JavadocClassReader extends ClassReader { |
| duke@1 | 39 | |
| duke@1 | 40 | public static JavadocClassReader instance0(Context context) { |
| duke@1 | 41 | ClassReader instance = context.get(classReaderKey); |
| duke@1 | 42 | if (instance == null) |
| duke@1 | 43 | instance = new JavadocClassReader(context); |
| duke@1 | 44 | return (JavadocClassReader)instance; |
| duke@1 | 45 | } |
| duke@1 | 46 | |
| duke@1 | 47 | public static void preRegister(final Context context) { |
| duke@1 | 48 | context.put(classReaderKey, new Context.Factory<ClassReader>() { |
| duke@1 | 49 | public ClassReader make() { |
| duke@1 | 50 | return new JavadocClassReader(context); |
| duke@1 | 51 | } |
| duke@1 | 52 | }); |
| duke@1 | 53 | } |
| duke@1 | 54 | |
| duke@1 | 55 | private DocEnv docenv; |
| duke@1 | 56 | private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS, |
| duke@1 | 57 | JavaFileObject.Kind.SOURCE, |
| duke@1 | 58 | JavaFileObject.Kind.HTML); |
| duke@1 | 59 | private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS, |
| duke@1 | 60 | JavaFileObject.Kind.HTML); |
| duke@1 | 61 | |
| duke@1 | 62 | private JavadocClassReader(Context context) { |
| duke@1 | 63 | super(context, true); |
| duke@1 | 64 | docenv = DocEnv.instance(context); |
| duke@1 | 65 | } |
| duke@1 | 66 | |
| duke@1 | 67 | /** |
| duke@1 | 68 | * Override getPackageFileKinds to include search for package.html |
| duke@1 | 69 | */ |
| duke@1 | 70 | @Override |
| duke@1 | 71 | protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() { |
| duke@1 | 72 | return docenv.docClasses ? noSource : all; |
| duke@1 | 73 | } |
| duke@1 | 74 | |
| duke@1 | 75 | /** |
| duke@1 | 76 | * Override extraFileActions to check for package documentation |
| duke@1 | 77 | */ |
| duke@1 | 78 | @Override |
| duke@1 | 79 | protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) { |
| jjg@197 | 80 | if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML)) |
| jjg@197 | 81 | docenv.getPackageDoc(pack).setDocPath(fo); |
| duke@1 | 82 | } |
| duke@1 | 83 | } |
