Thu, 02 Oct 2008 19:58:40 -0700
6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell
duke@1 | 1 | /* |
xdono@117 | 2 | * Copyright 2002-2008 Sun Microsystems, Inc. All Rights Reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@1 | 23 | * have any questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.util; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 29 | import com.sun.javadoc.*; |
duke@1 | 30 | import java.util.*; |
duke@1 | 31 | |
duke@1 | 32 | /** |
duke@1 | 33 | * Provides methods for creating an array of class, method and |
duke@1 | 34 | * field names to be included as meta keywords in the HTML header |
duke@1 | 35 | * of class pages. These keywords improve search results |
duke@1 | 36 | * on browsers that look for keywords. |
duke@1 | 37 | * |
duke@1 | 38 | * This code is not part of an API. |
duke@1 | 39 | * It is implementation that is subject to change. |
duke@1 | 40 | * Do not use it as an API |
duke@1 | 41 | * |
duke@1 | 42 | * @author Doug Kramer |
duke@1 | 43 | */ |
duke@1 | 44 | public class MetaKeywords { |
duke@1 | 45 | |
duke@1 | 46 | private static MetaKeywords instance = null; |
duke@1 | 47 | |
duke@1 | 48 | /** |
duke@1 | 49 | * The global configuration information for this run. |
duke@1 | 50 | */ |
duke@1 | 51 | private final Configuration configuration; |
duke@1 | 52 | |
duke@1 | 53 | /** |
duke@1 | 54 | * Constructor |
duke@1 | 55 | */ |
duke@1 | 56 | private MetaKeywords(Configuration configuration) { |
duke@1 | 57 | this.configuration = configuration; |
duke@1 | 58 | } |
duke@1 | 59 | |
duke@1 | 60 | /** |
duke@1 | 61 | * Return an instance of MetaKeywords. This class is a singleton. |
duke@1 | 62 | * |
duke@1 | 63 | * @param configuration the current configuration of the doclet. |
duke@1 | 64 | */ |
duke@1 | 65 | public static MetaKeywords getInstance(Configuration configuration) { |
duke@1 | 66 | if (instance == null) { |
duke@1 | 67 | instance = new MetaKeywords(configuration); |
duke@1 | 68 | } |
duke@1 | 69 | return instance; |
duke@1 | 70 | } |
duke@1 | 71 | |
duke@1 | 72 | /** |
duke@1 | 73 | * Returns an array of strings where each element |
duke@1 | 74 | * is a class, method or field name. This array is |
duke@1 | 75 | * used to create one meta keyword tag for each element. |
duke@1 | 76 | * Method parameter lists are converted to "()" and |
duke@1 | 77 | * overloads are combined. |
duke@1 | 78 | * |
duke@1 | 79 | * Constructors are not included because they have the same |
duke@1 | 80 | * name as the class, which is already included. |
duke@1 | 81 | * Nested class members are not included because their |
duke@1 | 82 | * definitions are on separate pages. |
duke@1 | 83 | */ |
duke@1 | 84 | public String[] getMetaKeywords(ClassDoc classdoc) { |
jjg@74 | 85 | ArrayList<String> results = new ArrayList<String>(); |
duke@1 | 86 | |
duke@1 | 87 | // Add field and method keywords only if -keywords option is used |
duke@1 | 88 | if( configuration.keywords ) { |
duke@1 | 89 | results.addAll(getClassKeyword(classdoc)); |
duke@1 | 90 | results.addAll(getMemberKeywords(classdoc.fields())); |
duke@1 | 91 | results.addAll(getMemberKeywords(classdoc.methods())); |
duke@1 | 92 | } |
jjg@74 | 93 | return results.toArray(new String[]{}); |
duke@1 | 94 | } |
duke@1 | 95 | |
duke@1 | 96 | /** |
duke@1 | 97 | * Get the current class for a meta tag keyword, as the first |
duke@1 | 98 | * and only element of an array list. |
duke@1 | 99 | */ |
jjg@74 | 100 | protected ArrayList<String> getClassKeyword(ClassDoc classdoc) { |
duke@1 | 101 | String cltypelower = classdoc.isInterface() ? "interface" : "class"; |
jjg@74 | 102 | ArrayList<String> metakeywords = new ArrayList<String>(1); |
duke@1 | 103 | metakeywords.add(classdoc.qualifiedName() + " " + cltypelower); |
duke@1 | 104 | return metakeywords; |
duke@1 | 105 | } |
duke@1 | 106 | |
duke@1 | 107 | /** |
duke@1 | 108 | * Get the package keywords. |
duke@1 | 109 | */ |
duke@1 | 110 | public String[] getMetaKeywords(PackageDoc packageDoc) { |
duke@1 | 111 | if( configuration.keywords ) { |
duke@1 | 112 | String pkgName = Util.getPackageName(packageDoc); |
duke@1 | 113 | return new String[] { pkgName + " " + "package" }; |
duke@1 | 114 | } else { |
duke@1 | 115 | return new String[] {}; |
duke@1 | 116 | } |
duke@1 | 117 | } |
duke@1 | 118 | |
duke@1 | 119 | /** |
duke@1 | 120 | * Get the overview keywords. |
duke@1 | 121 | */ |
duke@1 | 122 | public String[] getOverviewMetaKeywords(String title, String docTitle) { |
duke@1 | 123 | if( configuration.keywords ) { |
duke@1 | 124 | String windowOverview = configuration.getText(title); |
duke@1 | 125 | String[] metakeywords = { windowOverview }; |
duke@1 | 126 | if (docTitle.length() > 0 ) { |
duke@1 | 127 | metakeywords[0] += ", " + docTitle; |
duke@1 | 128 | } |
duke@1 | 129 | return metakeywords; |
duke@1 | 130 | } else { |
duke@1 | 131 | return new String[] {}; |
duke@1 | 132 | } |
duke@1 | 133 | } |
duke@1 | 134 | |
duke@1 | 135 | /** |
duke@1 | 136 | * Get members for meta tag keywords as an array, |
duke@1 | 137 | * where each member name is a string element of the array. |
duke@1 | 138 | * The parameter lists are not included in the keywords; |
duke@1 | 139 | * therefore all overloaded methods are combined.<br> |
duke@1 | 140 | * Example: getValue(Object) is returned in array as getValue() |
duke@1 | 141 | * |
duke@1 | 142 | * @param memberdocs array of MemberDoc objects to be added to keywords |
duke@1 | 143 | */ |
jjg@74 | 144 | protected ArrayList<String> getMemberKeywords(MemberDoc[] memberdocs) { |
jjg@74 | 145 | ArrayList<String> results = new ArrayList<String>(); |
duke@1 | 146 | String membername; |
duke@1 | 147 | for (int i=0; i < memberdocs.length; i++) { |
duke@1 | 148 | membername = memberdocs[i].name() |
duke@1 | 149 | + (memberdocs[i].isMethod() ? "()" : ""); |
duke@1 | 150 | if ( ! results.contains(membername) ) { |
duke@1 | 151 | results.add(membername); |
duke@1 | 152 | } |
duke@1 | 153 | } |
duke@1 | 154 | return results; |
duke@1 | 155 | } |
duke@1 | 156 | } |