author | ksrini |
Fri, 09 Feb 2018 13:58:17 -0800 | |
changeset 48840 | 5e2d2067da48 |
parent 47216 | 71c04702a3d5 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
48840
5e2d2067da48
8194651: javadoc: mark the com.sun.javadoc API for removal
ksrini
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 2001, 2018, Oracle and/or its affiliates. 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
37938
42baa89d2156
8075703: jdk.javadoc module exports com.sun.tools.javadoc package which contains a lot of internal API.
jjg
parents:
25874
diff
changeset
|
26 |
package com.sun.tools.javadoc.main; |
10 | 27 |
|
1869 | 28 |
import java.util.EnumSet; |
29 |
import javax.tools.JavaFileObject; |
|
30 |
||
10 | 31 |
import com.sun.tools.javac.code.Symbol.PackageSymbol; |
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
22442
diff
changeset
|
32 |
import com.sun.tools.javac.code.ClassFinder; |
10 | 33 |
import com.sun.tools.javac.util.Context; |
42827
36468b5fa7f4
8181370: Convert anonymous inner classes into lambdas/method references
mcimadamore
parents:
38617
diff
changeset
|
34 |
import com.sun.tools.javac.util.Context.Factory; |
10 | 35 |
|
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
22442
diff
changeset
|
36 |
/** Javadoc uses an extended class finder that records package.html entries |
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
10189
diff
changeset
|
37 |
* |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
10189
diff
changeset
|
38 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
10189
diff
changeset
|
39 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
10189
diff
changeset
|
40 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
10189
diff
changeset
|
41 |
* deletion without notice.</b> |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
10189
diff
changeset
|
42 |
* |
10 | 43 |
* @author Neal Gafter |
44 |
*/ |
|
48840
5e2d2067da48
8194651: javadoc: mark the com.sun.javadoc API for removal
ksrini
parents:
47216
diff
changeset
|
45 |
@Deprecated(since="9", forRemoval=true) |
5e2d2067da48
8194651: javadoc: mark the com.sun.javadoc API for removal
ksrini
parents:
47216
diff
changeset
|
46 |
@SuppressWarnings("removal") |
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
22442
diff
changeset
|
47 |
public class JavadocClassFinder extends ClassFinder { |
10 | 48 |
|
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
22442
diff
changeset
|
49 |
public static JavadocClassFinder instance(Context context) { |
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
22442
diff
changeset
|
50 |
ClassFinder instance = context.get(classFinderKey); |
10 | 51 |
if (instance == null) |
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
22442
diff
changeset
|
52 |
instance = new JavadocClassFinder(context); |
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
22442
diff
changeset
|
53 |
return (JavadocClassFinder)instance; |
10 | 54 |
} |
55 |
||
8614 | 56 |
public static void preRegister(Context context) { |
42827
36468b5fa7f4
8181370: Convert anonymous inner classes into lambdas/method references
mcimadamore
parents:
38617
diff
changeset
|
57 |
context.put(classFinderKey, (Factory<ClassFinder>)JavadocClassFinder::new); |
10 | 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 |
||
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
22442
diff
changeset
|
67 |
public JavadocClassFinder(Context context) { |
22442
8fd30fc4e3a3
8029690: Move symbol creation from ClassReader to Symtab
jfranck
parents:
14260
diff
changeset
|
68 |
super(context); |
10 | 69 |
docenv = DocEnv.instance(context); |
7332
3e90e60e4ce8
6942366: javadoc no longer inherits doc from sourcepath
jjg
parents:
5520
diff
changeset
|
70 |
preferSource = true; |
10 | 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) { |
|
1869 | 86 |
if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML)) |
87 |
docenv.getPackageDoc(pack).setDocPath(fo); |
|
10 | 88 |
} |
89 |
} |