/* * Copyright (c) 2019, 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 8227047 * @summary Sealed types * @library /tools/lib ../../lib * @modules jdk.javadoc/jdk.javadoc.internal.tool * @build toolbox.ToolBox javadoc.tester.* * @run main TestSealedTypes */ import java.io.IOException; import java.nio.file.Path; import javadoc.tester.JavadocTester; import toolbox.ToolBox; public class TestSealedTypes extends JavadocTester { public static void main(String... args) throws Exception { var tester = new TestSealedTypes(); tester.runTests(); } private final ToolBox tb = new ToolBox(); @Test public void testSealedModifierClass(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A { }"); javadoc("-d", base.resolve("out").toString(), "-sourcepath", src.toString(), "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A """); } @Test public void testSealedModifierInterface(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed interface A { }"); javadoc("-d", base.resolve("out").toString(), "-sourcepath", src.toString(), "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed interface A

"""); } @Test public void testNonSealedModifierClass(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A permits B { }", "package p; public non-sealed class B extends A { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A """); checkOutput("p/B.html", true, """

public non-sealed class B """); } @Test public void testNonSealedModifierInterface(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed interface A permits B { }", "package p; public non-sealed interface B extends A { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed interface A """); checkOutput("p/B.html", true, """

public non-sealed interface B extends A

"""); } @Test public void testSealedSubtypeModifierClass(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A permits B { }", "package p; public sealed abstract class B extends A { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A """); checkOutput("p/B.html", true, """

public abstract sealed class B """); } @Test public void testSealedSubtypeInterface(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed interface A permits B { }", "package p; public sealed interface B extends A { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed interface A """); checkOutput("p/B.html", true, """

public sealed interface B extends A

"""); } @Test public void testSinglePermits(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A permits B { }", "package p; public final class B extends A { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "--no-platform-links", "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A extends java.lang.Object permits B

"""); } @Test public void testMultiplePermits(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A permits B,C,D { }", "package p; public final class B extends A { }", "package p; public final class C extends A { }", "package p; public final class D extends A { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "--no-platform-links", "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A extends java.lang.Object permits B, C, D

"""); } @Test public void testPartialMultiplePermits(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A permits B,C,D { }", "package p; public final class B extends A { }", "package p; public final class C extends A { }", "package p; final class D extends A { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "--no-platform-links", "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A extends java.lang.Object permits B, C (not exhaustive)

"""); } @Test public void testPartialMultiplePermitsWithSubtypes1(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A permits B,C,D { }", "package p; public final class B extends A { }", "package p; public final class C extends A { }", "package p; sealed class D extends A permits D1, D2 { }", "package p; public final class D1 extends D { }", "package p; public final class D2 extends D { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "--no-platform-links", "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A extends java.lang.Object permits B, C (not exhaustive)

"""); } @Test public void testPartialMultiplePermitsWithSubtypes2(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A permits B,C,D { }", "package p; public final class B extends A { }", "package p; public final class C extends A { }", "package p; non-sealed class D extends A { }", "package p; public final class D1 extends D { }", "package p; public final class D2 extends D { }"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "--no-platform-links", "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A extends java.lang.Object permits B, C (not exhaustive)

"""); } @Test public void testImplicitPermitsAuxiliary(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A { }\n" + "final class B extends A { }\n" + "final class C extends A { }\n" + "final class D extends A { }\n"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "--no-platform-links", "-package", "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A extends java.lang.Object permits B, C, D

"""); } @Test public void testImplicitPermitsNested(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public sealed class A {\n" + " public static final class B extends A { }\n" + " public static final class C extends A { }\n" + " public static final class D extends A { }\n" + "}"); javadoc("-d", base.resolve("out").toString(), "--source-path", src.toString(), "--no-platform-links", "p"); checkExit(Exit.OK); checkOutput("p/A.html", true, """

public sealed class A extends java.lang.Object permits A.B, A.C, A.D

"""); } }