10
|
1 |
/*
|
2212
|
2 |
* Copyright 2001-2009 Sun Microsystems, Inc. All Rights Reserved.
|
10
|
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. Sun designates this
|
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
9 |
* by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
|
|
22 |
* CA 95054 USA or visit www.sun.com if you need additional information or
|
|
23 |
* have any questions.
|
|
24 |
*/
|
|
25 |
|
|
26 |
package com.sun.tools.javadoc;
|
|
27 |
|
1869
|
28 |
import java.util.EnumSet;
|
|
29 |
import javax.tools.JavaFileObject;
|
|
30 |
|
10
|
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;
|
|
34 |
|
|
35 |
/** Javadoc uses an extended class reader that records package.html entries
|
|
36 |
* @author Neal Gafter
|
|
37 |
*/
|
|
38 |
class JavadocClassReader extends ClassReader {
|
|
39 |
|
|
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 |
}
|
|
46 |
|
|
47 |
public static void preRegister(final Context context) {
|
|
48 |
context.put(classReaderKey, new Context.Factory<ClassReader>() {
|
|
49 |
public ClassReader make() {
|
|
50 |
return new JavadocClassReader(context);
|
|
51 |
}
|
|
52 |
});
|
|
53 |
}
|
|
54 |
|
|
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);
|
|
61 |
|
|
62 |
private JavadocClassReader(Context context) {
|
|
63 |
super(context, true);
|
|
64 |
docenv = DocEnv.instance(context);
|
|
65 |
}
|
|
66 |
|
|
67 |
/**
|
|
68 |
* Override getPackageFileKinds to include search for package.html
|
|
69 |
*/
|
|
70 |
@Override
|
|
71 |
protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() {
|
|
72 |
return docenv.docClasses ? noSource : all;
|
|
73 |
}
|
|
74 |
|
|
75 |
/**
|
|
76 |
* Override extraFileActions to check for package documentation
|
|
77 |
*/
|
|
78 |
@Override
|
|
79 |
protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) {
|
1869
|
80 |
if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML))
|
|
81 |
docenv.getPackageDoc(pack).setDocPath(fo);
|
10
|
82 |
}
|
|
83 |
}
|