duke@1: /* xdono@117: * Copyright 2002-2008 Sun Microsystems, Inc. All Rights Reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as duke@1: * published by the Free Software Foundation. Sun designates this duke@1: * particular file as subject to the "Classpath" exception as provided duke@1: * by Sun in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or duke@1: * have any questions. duke@1: */ duke@1: duke@1: package com.sun.tools.doclets.internal.toolkit.util; duke@1: duke@1: import com.sun.tools.doclets.internal.toolkit.*; duke@1: import com.sun.javadoc.*; duke@1: import java.util.*; duke@1: duke@1: /** duke@1: * Provides methods for creating an array of class, method and duke@1: * field names to be included as meta keywords in the HTML header duke@1: * of class pages. These keywords improve search results duke@1: * on browsers that look for keywords. duke@1: * duke@1: * This code is not part of an API. duke@1: * It is implementation that is subject to change. duke@1: * Do not use it as an API duke@1: * duke@1: * @author Doug Kramer duke@1: */ duke@1: public class MetaKeywords { duke@1: duke@1: private static MetaKeywords instance = null; duke@1: duke@1: /** duke@1: * The global configuration information for this run. duke@1: */ duke@1: private final Configuration configuration; duke@1: duke@1: /** duke@1: * Constructor duke@1: */ duke@1: private MetaKeywords(Configuration configuration) { duke@1: this.configuration = configuration; duke@1: } duke@1: duke@1: /** duke@1: * Return an instance of MetaKeywords. This class is a singleton. duke@1: * duke@1: * @param configuration the current configuration of the doclet. duke@1: */ duke@1: public static MetaKeywords getInstance(Configuration configuration) { duke@1: if (instance == null) { duke@1: instance = new MetaKeywords(configuration); duke@1: } duke@1: return instance; duke@1: } duke@1: duke@1: /** duke@1: * Returns an array of strings where each element duke@1: * is a class, method or field name. This array is duke@1: * used to create one meta keyword tag for each element. duke@1: * Method parameter lists are converted to "()" and duke@1: * overloads are combined. duke@1: * duke@1: * Constructors are not included because they have the same duke@1: * name as the class, which is already included. duke@1: * Nested class members are not included because their duke@1: * definitions are on separate pages. duke@1: */ duke@1: public String[] getMetaKeywords(ClassDoc classdoc) { jjg@74: ArrayList results = new ArrayList(); duke@1: duke@1: // Add field and method keywords only if -keywords option is used duke@1: if( configuration.keywords ) { duke@1: results.addAll(getClassKeyword(classdoc)); duke@1: results.addAll(getMemberKeywords(classdoc.fields())); duke@1: results.addAll(getMemberKeywords(classdoc.methods())); duke@1: } jjg@74: return results.toArray(new String[]{}); duke@1: } duke@1: duke@1: /** duke@1: * Get the current class for a meta tag keyword, as the first duke@1: * and only element of an array list. duke@1: */ jjg@74: protected ArrayList getClassKeyword(ClassDoc classdoc) { duke@1: String cltypelower = classdoc.isInterface() ? "interface" : "class"; jjg@74: ArrayList metakeywords = new ArrayList(1); duke@1: metakeywords.add(classdoc.qualifiedName() + " " + cltypelower); duke@1: return metakeywords; duke@1: } duke@1: duke@1: /** duke@1: * Get the package keywords. duke@1: */ duke@1: public String[] getMetaKeywords(PackageDoc packageDoc) { duke@1: if( configuration.keywords ) { duke@1: String pkgName = Util.getPackageName(packageDoc); duke@1: return new String[] { pkgName + " " + "package" }; duke@1: } else { duke@1: return new String[] {}; duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Get the overview keywords. duke@1: */ duke@1: public String[] getOverviewMetaKeywords(String title, String docTitle) { duke@1: if( configuration.keywords ) { duke@1: String windowOverview = configuration.getText(title); duke@1: String[] metakeywords = { windowOverview }; duke@1: if (docTitle.length() > 0 ) { duke@1: metakeywords[0] += ", " + docTitle; duke@1: } duke@1: return metakeywords; duke@1: } else { duke@1: return new String[] {}; duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Get members for meta tag keywords as an array, duke@1: * where each member name is a string element of the array. duke@1: * The parameter lists are not included in the keywords; duke@1: * therefore all overloaded methods are combined.
duke@1: * Example: getValue(Object) is returned in array as getValue() duke@1: * duke@1: * @param memberdocs array of MemberDoc objects to be added to keywords duke@1: */ jjg@74: protected ArrayList getMemberKeywords(MemberDoc[] memberdocs) { jjg@74: ArrayList results = new ArrayList(); duke@1: String membername; duke@1: for (int i=0; i < memberdocs.length; i++) { duke@1: membername = memberdocs[i].name() duke@1: + (memberdocs[i].isMethod() ? "()" : ""); duke@1: if ( ! results.contains(membername) ) { duke@1: results.add(membername); duke@1: } duke@1: } duke@1: return results; duke@1: } duke@1: }