354 lines
14 KiB
Java
354 lines
14 KiB
Java
/*
|
|
* Copyright (c) 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 8067757
|
|
* @library /tools/lib ../../lib
|
|
* @modules jdk.compiler/com.sun.tools.javac.api
|
|
* jdk.compiler/com.sun.tools.javac.main
|
|
* jdk.javadoc/jdk.javadoc.internal.tool
|
|
* @build toolbox.ToolBox javadoc.tester.*
|
|
* @run main TestOneToMany
|
|
*/
|
|
|
|
import javadoc.tester.JavadocTester;
|
|
import toolbox.ToolBox;
|
|
|
|
import java.nio.file.Path;
|
|
import java.nio.file.Paths;
|
|
|
|
public class TestOneToMany extends JavadocTester {
|
|
|
|
public static void main(String... args) throws Exception {
|
|
var tester = new TestOneToMany();
|
|
tester.runTests(m -> new Object[]{Paths.get(m.getName())});
|
|
}
|
|
|
|
private final ToolBox tb = new ToolBox();
|
|
|
|
// These tests:
|
|
//
|
|
// - Use own exceptions to not depend on platform links or a setup with
|
|
// the no-platform-links option
|
|
// - Enclose files in a package to exercise a typical source layout and
|
|
// avoid enumerating separate files in the javadoc command
|
|
|
|
@Test
|
|
public void testUncheckedException(Path base) throws Exception {
|
|
var src = base.resolve("src");
|
|
tb.writeJavaFiles(src, """
|
|
package x;
|
|
|
|
public class MyRuntimeException extends RuntimeException { }
|
|
""", """
|
|
package x;
|
|
|
|
public interface I {
|
|
|
|
/**
|
|
* @throws MyRuntimeException if this
|
|
* @throws MyRuntimeException if that
|
|
*/
|
|
void m();
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public interface I1 extends I {
|
|
|
|
@Override
|
|
void m() throws MyRuntimeException;
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class IImpl implements I {
|
|
|
|
@Override
|
|
public void m() throws MyRuntimeException { }
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class C {
|
|
|
|
/**
|
|
* @throws MyRuntimeException if this
|
|
* @throws MyRuntimeException if that
|
|
*/
|
|
public void m();
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class C1 extends C {
|
|
|
|
@Override
|
|
public void m() throws MyRuntimeException { }
|
|
}
|
|
""");
|
|
javadoc("-d", base.resolve("out").toString(),
|
|
"-sourcepath", src.toString(),
|
|
"x");
|
|
checkExit(Exit.OK);
|
|
checkOutput("x/IImpl.html", true, """
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="I.html#m()">m</a></code> in interface <code><a href="I.html" title="interface in x">I</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if this</dd>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if that</dd>
|
|
</dl>""");
|
|
checkOutput("x/I1.html", true, """
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="I.html#m()">m</a></code> in interface <code><a href="I.html" title="interface in x">I</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if this</dd>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if that</dd>
|
|
</dl>""");
|
|
checkOutput("x/C1.html", true, """
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="C.html#m()">m</a></code> in class <code><a href="C.html" title="class in x">C</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if this</dd>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if that</dd>
|
|
</dl>""");
|
|
}
|
|
|
|
@Test
|
|
public void testUncheckedExceptionWithRedundantThrows(Path base) throws Exception {
|
|
var src = base.resolve("src");
|
|
tb.writeJavaFiles(src, """
|
|
package x;
|
|
|
|
public class MyRuntimeException extends RuntimeException { }
|
|
""", """
|
|
package x;
|
|
|
|
public interface I {
|
|
|
|
/**
|
|
* @throws MyRuntimeException if this
|
|
* @throws MyRuntimeException if that
|
|
*/
|
|
void m() throws MyRuntimeException;
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public interface I1 extends I {
|
|
|
|
@Override
|
|
void m() throws MyRuntimeException;
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class IImpl implements I {
|
|
|
|
@Override
|
|
public void m() throws MyRuntimeException { }
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class C {
|
|
|
|
/**
|
|
* @throws MyRuntimeException if this
|
|
* @throws MyRuntimeException if that
|
|
*/
|
|
public void m() throws MyRuntimeException;
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class C1 extends C {
|
|
|
|
@Override
|
|
public void m() throws MyRuntimeException { }
|
|
}
|
|
""");
|
|
javadoc("-d", base.resolve("out").toString(),
|
|
"-sourcepath", src.toString(),
|
|
"x");
|
|
checkExit(Exit.OK);
|
|
checkOutput("x/IImpl.html", true, """
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="I.html#m()">m</a></code> in interface <code><a href="I.html" title="interface in x">I</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if this</dd>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if that</dd>
|
|
</dl>""");
|
|
checkOutput("x/I1.html", true, """
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="I.html#m()">m</a></code> in interface <code><a href="I.html" title="interface in x">I</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if this</dd>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if that</dd>
|
|
</dl>""");
|
|
checkOutput("x/C1.html", true, """
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="C.html#m()">m</a></code> in class <code><a href="C.html" title="class in x">C</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if this</dd>
|
|
<dd><code><a href="MyRuntimeException.html" title="class in x">MyRuntimeException</a></code> - if that</dd>
|
|
</dl>""");
|
|
}
|
|
|
|
@Test
|
|
public void testCheckedException(Path base) throws Exception {
|
|
var src = base.resolve("src");
|
|
tb.writeJavaFiles(src, """
|
|
package x;
|
|
|
|
public class MyCheckedException extends Exception { }
|
|
""", """
|
|
package x;
|
|
|
|
public interface I {
|
|
|
|
/**
|
|
* @throws MyCheckedException if this
|
|
* @throws MyCheckedException if that
|
|
*/
|
|
void m() throws MyCheckedException;
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public interface I1 extends I {
|
|
|
|
@Override
|
|
void m() throws MyCheckedException;
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class IImpl implements I {
|
|
|
|
@Override
|
|
public void m() throws MyCheckedException { }
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class C {
|
|
|
|
/**
|
|
* @throws MyCheckedException if this
|
|
* @throws MyCheckedException if that
|
|
*/
|
|
public void m() throws MyCheckedException;
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public class C1 extends C {
|
|
|
|
@Override
|
|
public void m() throws MyCheckedException { }
|
|
}
|
|
""");
|
|
javadoc("-d", base.resolve("out").toString(),
|
|
"-sourcepath", src.toString(),
|
|
"x");
|
|
checkExit(Exit.OK);
|
|
checkOutput("x/IImpl.html", true, """
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="I.html#m()">m</a></code> in interface <code><a href="I.html" title="interface in x">I</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyCheckedException.html" title="class in x">MyCheckedException</a></code> - if this</dd>
|
|
<dd><code><a href="MyCheckedException.html" title="class in x">MyCheckedException</a></code> - if that</dd>
|
|
</dl>""");
|
|
checkOutput("x/I1.html", true, """
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="I.html#m()">m</a></code> in interface <code><a href="I.html" title="interface in x">I</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyCheckedException.html" title="class in x">MyCheckedException</a></code> - if this</dd>
|
|
<dd><code><a href="MyCheckedException.html" title="class in x">MyCheckedException</a></code> - if that</dd>
|
|
</dl>""");
|
|
checkOutput("x/C1.html", true, """
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="C.html#m()">m</a></code> in class <code><a href="C.html" title="class in x">C</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyCheckedException.html" title="class in x">MyCheckedException</a></code> - if this</dd>
|
|
<dd><code><a href="MyCheckedException.html" title="class in x">MyCheckedException</a></code> - if that</dd>
|
|
</dl>""");
|
|
}
|
|
|
|
@Test
|
|
public void testSubExceptionDoubleInheritance(Path base) throws Exception {
|
|
var src = base.resolve("src");
|
|
tb.writeJavaFiles(src, """
|
|
package x;
|
|
|
|
public class MyException extends Exception { }
|
|
""", """
|
|
package x;
|
|
|
|
public class MySubException extends MyException { }
|
|
""", """
|
|
package x;
|
|
|
|
public interface I {
|
|
|
|
/**
|
|
* @throws MyException if this
|
|
* @throws MySubException if that
|
|
*/
|
|
void m() throws MyException, MySubException;
|
|
}
|
|
""", """
|
|
package x;
|
|
|
|
public interface I1 extends I {
|
|
|
|
@Override
|
|
void m() throws MyException, MySubException;
|
|
}
|
|
""");
|
|
javadoc("-d", base.resolve("out").toString(),
|
|
"-sourcepath", src.toString(),
|
|
"x");
|
|
checkExit(Exit.OK);
|
|
checkOutput("x/I1.html", true, """
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="I.html#m()">m</a></code> in interface <code><a href="I.html" title="interface in x">I</a></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="MyException.html" title="class in x">MyException</a></code> - if this</dd>
|
|
<dd><code><a href="MySubException.html" title="class in x">MySubException</a></code> - if that</dd>
|
|
</dl>""");
|
|
}
|
|
}
|