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

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/MetaKeywords.java@93012e2a5d1d (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/MetaKeywords.java

Sat, 07 Nov 2020 10:30:02 +0800

author

aoqi

date

Sat, 07 Nov 2020 10:30:02 +0800

changeset 3938

93012e2a5d1d

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2002, 2013, 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.doclets.internal.toolkit.util;
aoqi@0	27
aoqi@0	28	import java.util.*;
aoqi@0	29
aoqi@0	30	import com.sun.javadoc.*;
aoqi@0	31	import com.sun.tools.javac.jvm.Profile;
aoqi@0	32	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Provides methods for creating an array of class, method and
aoqi@0	36	* field names to be included as meta keywords in the HTML header
aoqi@0	37	* of class pages. These keywords improve search results
aoqi@0	38	* on browsers that look for keywords.
aoqi@0	39	*
aoqi@0	40	* <p><b>This is NOT part of any supported API.
aoqi@0	41	* If you write code that depends on this, you do so at your own risk.
aoqi@0	42	* This code and its internal interfaces are subject to change or
aoqi@0	43	* deletion without notice.</b>
aoqi@0	44	*
aoqi@0	45	* @author Doug Kramer
aoqi@0	46	*/
aoqi@0	47	public class MetaKeywords {
aoqi@0	48
aoqi@0	49	/**
aoqi@0	50	* The global configuration information for this run.
aoqi@0	51	*/
aoqi@0	52	private final Configuration configuration;
aoqi@0	53
aoqi@0	54	/**
aoqi@0	55	* Constructor
aoqi@0	56	*/
aoqi@0	57	public MetaKeywords(Configuration configuration) {
aoqi@0	58	this.configuration = configuration;
aoqi@0	59	}
aoqi@0	60
aoqi@0	61	/**
aoqi@0	62	* Returns an array of strings where each element
aoqi@0	63	* is a class, method or field name. This array is
aoqi@0	64	* used to create one meta keyword tag for each element.
aoqi@0	65	* Method parameter lists are converted to "()" and
aoqi@0	66	* overloads are combined.
aoqi@0	67	*
aoqi@0	68	* Constructors are not included because they have the same
aoqi@0	69	* name as the class, which is already included.
aoqi@0	70	* Nested class members are not included because their
aoqi@0	71	* definitions are on separate pages.
aoqi@0	72	*/
aoqi@0	73	public String[] getMetaKeywords(ClassDoc classdoc) {
aoqi@0	74	ArrayList<String> results = new ArrayList<String>();
aoqi@0	75
aoqi@0	76	// Add field and method keywords only if -keywords option is used
aoqi@0	77	if( configuration.keywords ) {
aoqi@0	78	results.addAll(getClassKeyword(classdoc));
aoqi@0	79	results.addAll(getMemberKeywords(classdoc.fields()));
aoqi@0	80	results.addAll(getMemberKeywords(classdoc.methods()));
aoqi@0	81	}
aoqi@0	82	return results.toArray(new String[]{});
aoqi@0	83	}
aoqi@0	84
aoqi@0	85	/**
aoqi@0	86	* Get the current class for a meta tag keyword, as the first
aoqi@0	87	* and only element of an array list.
aoqi@0	88	*/
aoqi@0	89	protected ArrayList<String> getClassKeyword(ClassDoc classdoc) {
aoqi@0	90	String cltypelower = classdoc.isInterface() ? "interface" : "class";
aoqi@0	91	ArrayList<String> metakeywords = new ArrayList<String>(1);
aoqi@0	92	metakeywords.add(classdoc.qualifiedName() + " " + cltypelower);
aoqi@0	93	return metakeywords;
aoqi@0	94	}
aoqi@0	95
aoqi@0	96	/**
aoqi@0	97	* Get the package keywords.
aoqi@0	98	*/
aoqi@0	99	public String[] getMetaKeywords(PackageDoc packageDoc) {
aoqi@0	100	if( configuration.keywords ) {
aoqi@0	101	String pkgName = Util.getPackageName(packageDoc);
aoqi@0	102	return new String[] { pkgName + " " + "package" };
aoqi@0	103	} else {
aoqi@0	104	return new String[] {};
aoqi@0	105	}
aoqi@0	106	}
aoqi@0	107
aoqi@0	108	/**
aoqi@0	109	* Get the profile keywords.
aoqi@0	110	*
aoqi@0	111	* @param profile the profile being documented
aoqi@0	112	*/
aoqi@0	113	public String[] getMetaKeywords(Profile profile) {
aoqi@0	114	if( configuration.keywords ) {
aoqi@0	115	String profileName = profile.name;
aoqi@0	116	return new String[] { profileName + " " + "profile" };
aoqi@0	117	} else {
aoqi@0	118	return new String[] {};
aoqi@0	119	}
aoqi@0	120	}
aoqi@0	121
aoqi@0	122	/**
aoqi@0	123	* Get the overview keywords.
aoqi@0	124	*/
aoqi@0	125	public String[] getOverviewMetaKeywords(String title, String docTitle) {
aoqi@0	126	if( configuration.keywords ) {
aoqi@0	127	String windowOverview = configuration.getText(title);
aoqi@0	128	String[] metakeywords = { windowOverview };
aoqi@0	129	if (docTitle.length() > 0 ) {
aoqi@0	130	metakeywords[0] += ", " + docTitle;
aoqi@0	131	}
aoqi@0	132	return metakeywords;
aoqi@0	133	} else {
aoqi@0	134	return new String[] {};
aoqi@0	135	}
aoqi@0	136	}
aoqi@0	137
aoqi@0	138	/**
aoqi@0	139	* Get members for meta tag keywords as an array,
aoqi@0	140	* where each member name is a string element of the array.
aoqi@0	141	* The parameter lists are not included in the keywords;
aoqi@0	142	* therefore all overloaded methods are combined.<br>
aoqi@0	143	* Example: getValue(Object) is returned in array as getValue()
aoqi@0	144	*
aoqi@0	145	* @param memberdocs array of MemberDoc objects to be added to keywords
aoqi@0	146	*/
aoqi@0	147	protected ArrayList<String> getMemberKeywords(MemberDoc[] memberdocs) {
aoqi@0	148	ArrayList<String> results = new ArrayList<String>();
aoqi@0	149	String membername;
aoqi@0	150	for (int i=0; i < memberdocs.length; i++) {
aoqi@0	151	membername = memberdocs[i].name()
aoqi@0	152	+ (memberdocs[i].isMethod() ? "()" : "");
aoqi@0	153	if ( ! results.contains(membername) ) {
aoqi@0	154	results.add(membername);
aoqi@0	155	}
aoqi@0	156	}
aoqi@0	157	return results;
aoqi@0	158	}
aoqi@0	159	}