Mon, 16 Sep 2013 14:13:44 +0200
8021112: Spurious unchecked warning reported by javac
6480588: No way to suppress deprecation warnings when implementing deprecated interface
Summary: Fixing DeferredLintHandler configuration, so lint warnings are reported with correct @SuppressWarnings settings
Reviewed-by: jjg, vromero
duke@1 | 1 | /* |
bpatel@1995 | 2 | * Copyright (c) 2002, 2013, Oracle and/or its affiliates. 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. |
duke@1 | 8 | * |
duke@1 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 13 | * accompanied this code). |
duke@1 | 14 | * |
duke@1 | 15 | * You should have received a copy of the GNU General Public License version |
duke@1 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 18 | * |
ohair@554 | 19 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 20 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 21 | * questions. |
duke@1 | 22 | */ |
duke@1 | 23 | |
duke@1 | 24 | /* |
duke@1 | 25 | * @test |
bpatel@1995 | 26 | * @bug 4638136 7198273 |
duke@1 | 27 | * @summary Add ability to skip over nav bar for accessibility |
duke@1 | 28 | * @author dkramer |
duke@1 | 29 | * @run main AccessSkipNav |
duke@1 | 30 | */ |
duke@1 | 31 | |
duke@1 | 32 | |
duke@1 | 33 | import com.sun.javadoc.*; |
duke@1 | 34 | import java.util.*; |
duke@1 | 35 | import java.io.*; |
duke@1 | 36 | |
duke@1 | 37 | |
duke@1 | 38 | /** |
duke@1 | 39 | * Runs javadoc and runs regression tests on the resulting HTML. |
duke@1 | 40 | * It reads each file, complete with newlines, into a string to easily |
duke@1 | 41 | * find strings that contain newlines. |
duke@1 | 42 | */ |
duke@1 | 43 | public class AccessSkipNav { |
duke@1 | 44 | |
bpatel@1995 | 45 | private static final String BUGID = "4638136 - 7198273"; |
duke@1 | 46 | private static final String BUGNAME = "AccessSkipNav"; |
duke@1 | 47 | private static final String FS = System.getProperty("file.separator"); |
duke@1 | 48 | private static final String PS = System.getProperty("path.separator"); |
bpatel@766 | 49 | private static final String LS = System.getProperty("line.separator"); |
duke@1 | 50 | private static final String TMPDEST_DIR1 = "." + FS + "docs1" + FS; |
duke@1 | 51 | private static final String TMPDEST_DIR2 = "." + FS + "docs2" + FS; |
duke@1 | 52 | |
duke@1 | 53 | // Subtest number. Needed because runResultsOnHTML is run twice, |
duke@1 | 54 | // and subtestNum should increment across subtest runs. |
duke@1 | 55 | public static int subtestNum = 0; |
duke@1 | 56 | public static int numSubtestsPassed = 0; |
duke@1 | 57 | |
duke@1 | 58 | // Entry point |
duke@1 | 59 | public static void main(String[] args) { |
duke@1 | 60 | |
duke@1 | 61 | // Directory that contains source files that javadoc runs on |
duke@1 | 62 | String srcdir = System.getProperty("test.src", "."); |
duke@1 | 63 | |
duke@1 | 64 | // Test for all cases except the split index page |
duke@1 | 65 | runJavadoc(new String[] {"-d", TMPDEST_DIR1, |
duke@1 | 66 | "-sourcepath", srcdir, |
duke@1 | 67 | "p1", "p2"}); |
duke@1 | 68 | runTestsOnHTML(testArray); |
duke@1 | 69 | |
duke@1 | 70 | printSummary(); |
duke@1 | 71 | } |
duke@1 | 72 | |
duke@1 | 73 | /** Run javadoc */ |
duke@1 | 74 | public static void runJavadoc(String[] javadocArgs) { |
duke@1 | 75 | if (com.sun.tools.javadoc.Main.execute(javadocArgs) != 0) { |
duke@1 | 76 | throw new Error("Javadoc failed to execute"); |
duke@1 | 77 | } |
duke@1 | 78 | } |
duke@1 | 79 | |
duke@1 | 80 | /** |
duke@1 | 81 | * Assign value for [ stringToFind, filename ] |
duke@1 | 82 | * NOTE: The standard doclet uses the same separator "\n" for all OS's |
duke@1 | 83 | */ |
duke@1 | 84 | private static final String[][] testArray = { |
duke@1 | 85 | |
duke@1 | 86 | // Testing only for the presence of the <a href> and <a name> |
duke@1 | 87 | |
bpatel@766 | 88 | // Top navbar <a href> |
bpatel@1995 | 89 | { "<a href=\"#skip-navbar_top\" title=\"Skip navigation links\">Skip navigation links</a>", |
duke@1 | 90 | TMPDEST_DIR1 + "p1" + FS + "C1.html" }, |
duke@1 | 91 | |
bpatel@766 | 92 | // Top navbar <a name> |
bpatel@766 | 93 | { "<a name=\"skip-navbar_top\">" + LS + |
bpatel@766 | 94 | "<!-- -->" + LS + "</a>", |
duke@1 | 95 | TMPDEST_DIR1 + "p1" + FS + "C1.html" }, |
duke@1 | 96 | |
bpatel@766 | 97 | // Bottom navbar <a href> |
bpatel@1995 | 98 | { "<a href=\"#skip-navbar_bottom\" title=\"Skip navigation links\">Skip navigation links</a>", |
duke@1 | 99 | TMPDEST_DIR1 + "p1" + FS + "C1.html" }, |
duke@1 | 100 | |
bpatel@766 | 101 | // Bottom navbar <a name> |
bpatel@766 | 102 | { "<a name=\"skip-navbar_bottom\">" + LS + |
bpatel@766 | 103 | "<!-- -->" + LS + "</a>", |
duke@1 | 104 | TMPDEST_DIR1 + "p1" + FS + "C1.html" } |
duke@1 | 105 | }; |
duke@1 | 106 | |
duke@1 | 107 | public static void runTestsOnHTML(String[][] testArray) { |
duke@1 | 108 | |
duke@1 | 109 | for (int i = 0; i < testArray.length; i++) { |
duke@1 | 110 | |
duke@1 | 111 | subtestNum += 1; |
duke@1 | 112 | |
duke@1 | 113 | // Read contents of file into a string |
duke@1 | 114 | String fileString = readFileToString(testArray[i][1]); |
duke@1 | 115 | |
duke@1 | 116 | // Get string to find |
duke@1 | 117 | String stringToFind = testArray[i][0]; |
duke@1 | 118 | |
duke@1 | 119 | // Find string in file's contents |
duke@1 | 120 | if (findString(fileString, stringToFind) == -1) { |
duke@1 | 121 | System.out.println("\nSub-test " + (subtestNum) |
duke@1 | 122 | + " for bug " + BUGID + " (" + BUGNAME + ") FAILED\n" |
duke@1 | 123 | + "when searching for:\n" |
duke@1 | 124 | + stringToFind); |
duke@1 | 125 | } else { |
duke@1 | 126 | numSubtestsPassed += 1; |
duke@1 | 127 | System.out.println("\nSub-test " + (subtestNum) + " passed:\n" + stringToFind); |
duke@1 | 128 | } |
duke@1 | 129 | } |
duke@1 | 130 | } |
duke@1 | 131 | |
duke@1 | 132 | public static void printSummary() { |
duke@1 | 133 | if ( numSubtestsPassed == subtestNum ) { |
duke@1 | 134 | System.out.println("\nAll " + numSubtestsPassed + " subtests passed"); |
duke@1 | 135 | } else { |
duke@1 | 136 | throw new Error("\n" + (subtestNum - numSubtestsPassed) + " of " + (subtestNum) |
duke@1 | 137 | + " subtests failed for bug " + BUGID + " (" + BUGNAME + ")\n"); |
duke@1 | 138 | } |
duke@1 | 139 | } |
duke@1 | 140 | |
duke@1 | 141 | // Read the file into a String |
duke@1 | 142 | public static String readFileToString(String filename) { |
duke@1 | 143 | try { |
duke@1 | 144 | File file = new File(filename); |
duke@1 | 145 | if ( !file.exists() ) { |
duke@1 | 146 | System.out.println("\nFILE DOES NOT EXIST: " + filename); |
duke@1 | 147 | } |
duke@1 | 148 | BufferedReader in = new BufferedReader(new FileReader(file)); |
duke@1 | 149 | |
duke@1 | 150 | // Create an array of characters the size of the file |
duke@1 | 151 | char[] allChars = new char[(int)file.length()]; |
duke@1 | 152 | |
duke@1 | 153 | // Read the characters into the allChars array |
duke@1 | 154 | in.read(allChars, 0, (int)file.length()); |
duke@1 | 155 | in.close(); |
duke@1 | 156 | |
duke@1 | 157 | // Convert to a string |
duke@1 | 158 | String allCharsString = new String(allChars); |
duke@1 | 159 | |
duke@1 | 160 | return allCharsString; |
duke@1 | 161 | |
duke@1 | 162 | } catch (FileNotFoundException e) { |
duke@1 | 163 | System.err.println(e); |
duke@1 | 164 | return ""; |
duke@1 | 165 | } catch (IOException e) { |
duke@1 | 166 | System.err.println(e); |
duke@1 | 167 | return ""; |
duke@1 | 168 | } |
duke@1 | 169 | } |
duke@1 | 170 | |
duke@1 | 171 | public static int findString(String fileString, String stringToFind) { |
duke@1 | 172 | return fileString.indexOf(stringToFind); |
duke@1 | 173 | } |
duke@1 | 174 | } |