• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java@959103a6100f (annotated)

src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

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