1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
|
/*
* Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8254721 6251738
* @summary Improve support for conditionally generated files
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.* TestConditionalPages
* @run main TestConditionalPages
*/
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.function.Consumer;
import javadoc.tester.JavadocTester;
import toolbox.Task;
import toolbox.ToolBox;
public class TestConditionalPages extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestConditionalPages();
tester.runTests();
}
ToolBox tb = new ToolBox();
@Test
public void testConstantValues(Path base) throws IOException {
test(base, """
package p;
public class C {
public static final int ZERO = 0;
}
""",
"constant-values.html",
b -> checkOutput("index-all.html", b, "Constant Field Values"));
}
@Test
public void testDeprecated(Path base) throws IOException {
test(base, """
package p;
@Deprecated
public class C { }
""",
"deprecated-list.html",
b -> checkOutput("index-all.html", b, "Deprecated"));
}
@Test
public void testExternalSpecs(Path base) throws IOException {
test(base, """
package p;
/** @spec http://example.com label. */
public class C { }
""",
"external-specs.html",
b -> checkOutput("index-all.html", b, "External Specifications"));
}
@Test
public void testSerializedForm(Path base) throws IOException {
test(base, """
package p;
import java.io.Serializable;
public class C implements Serializable { }
""",
"serialized-form.html",
b -> checkOutput("index-all.html", b, "Serialized Form"));
}
@Test
public void testSystemProperties(Path base) throws IOException {
test(base, """
package p;
/** This class uses {@systemProperty line.separator}. */
public class C { }
""",
"system-properties.html",
b -> checkOutput("index-all.html", b, "System Properties"));
}
void test(Path base, String code, String file, Consumer<Boolean> extraChecks) throws IOException {
test(base.resolve("a"), code, file, extraChecks, true);
test(base.resolve("b"), "package p; public class C { }", file, extraChecks, false);
}
void test(Path base, String code, String file, Consumer<Boolean> extraChecks, boolean expect) throws IOException {
Path src = Files.createDirectories(base.resolve("src"));
tb.writeJavaFiles(src, code);
javadoc("-d", base.resolve("out").toString(),
"-sourcepath", src.toString(),
"p");
checkExit(Exit.OK);
checkFiles(expect, file);
checkOutput(Output.OUT, expect, "Generating " + base.resolve("out").resolve(file));
extraChecks.accept(expect);
}
}
|