test/langtools/jdk/javadoc/doclet/testNewLanguageFeatures/TestNewLanguageFeatures.java
/*
* Copyright (c) 2003, 2019, 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 4789689 4905985 4927164 4827184 4993906 5004549 7025314 7010344 8025633 8026567 8162363
* 8175200 8186332 8182765 8196202 8187288 8173730 8215307
* @summary Run Javadoc on a set of source files that demonstrate new
* language features. Check the output to ensure that the new
* language features are properly documented.
* @author jamieh
* @library ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestNewLanguageFeatures
*/
import javadoc.tester.JavadocTester;
public class TestNewLanguageFeatures extends JavadocTester {
public static void main(String... args) throws Exception {
TestNewLanguageFeatures tester = new TestNewLanguageFeatures();
tester.runTests();
}
@Test
public void test() {
javadoc("-Xdoclint:none",
"-d", "out",
"-use",
"--frames",
"-sourcepath", testSrc,
"pkg", "pkg1", "pkg2");
checkExit(Exit.OK);
checkEnums();
checkTypeParameters();
checkVarArgs();
checkAnnotationTypeUsage();
}
//=================================
// ENUM TESTING
//=================================
void checkEnums() {
checkOutput("pkg/Coin.html", true,
// Make sure enum header is correct.
"Enum Coin</h1>",
// Make sure enum signature is correct.
"<pre>public enum "
+ "<span class=\"typeNameLabel\">Coin</span>\n"
+ "extends java.lang.Enum<<a href=\"Coin.html\" "
+ "title=\"enum in pkg\">Coin</a>></pre>",
// Check for enum constant section
"<caption><span>Enum Constants"
+ "</span><span class=\"tabEnd\"> </span></caption>",
// Detail for enum constant
"<span class=\"memberNameLink\"><a href=\"#Dime\">Dime</a></span>",
// Automatically insert documentation for values() and valueOf().
"Returns an array containing the constants of this enum type,",
"Returns the enum constant of this type with the specified name",
"Overloaded valueOf() method has correct documentation.",
"Overloaded values method has correct documentation.",
"<pre class=\"methodSignature\">public static <a href=\"Coin.html\" title=\"enum in pkg\">Coin</a>" +
" valueOf​(java.lang.String name)</pre>\n" +
"<div class=\"block\">Returns the enum constant of this type with the specified name.\n" +
"The string must match <i>exactly</i> an identifier used to declare an\n" +
"enum constant in this type. (Extraneous whitespace characters are \n" +
"not permitted.)</div>\n" +
"<dl>\n" +
"<dt><span class=\"paramLabel\">Parameters:</span></dt>\n" +
"<dd><code>name</code> - the name of the enum constant to be returned.</dd>\n" +
"<dt><span class=\"returnLabel\">Returns:</span></dt>\n" +
"<dd>the enum constant with the specified name</dd>\n" +
"<dt><span class=\"throwsLabel\">Throws:</span></dt>\n" +
"<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no " +
"constant with the specified name</dd>\n" +
"<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>");
// NO constructor section
checkOutput("pkg/Coin.html", false,
"<h3>Constructor Summary</h3>");
}
//=================================
// TYPE PARAMETER TESTING
//=================================
void checkTypeParameters() {
checkOutput("pkg/TypeParameters.html", true,
// Make sure the header is correct.
"Class TypeParameters<E></h1>",
// Check class type parameters section.
"<dt><span class=\"paramLabel\">Type Parameters:</span></dt>\n"
+ "<dd><code>E</code> - "
+ "the type parameter for this class.",
// Type parameters in @see/@link
"<dl>\n"
+ "<dt><span class=\"seeLabel\">See Also:</span></dt>\n"
+ "<dd>"
+ "<a href=\"TypeParameters.html\" title=\"class in pkg\">"
+ "<code>TypeParameters</code></a></dd>\n"
+ "</dl>",
// Method that uses class type parameter.
"(<a href=\"TypeParameters.html\" title=\"type "
+ "parameter in TypeParameters\">E</a> param)",
// Method type parameter section.
"<span class=\"paramLabel\">Type Parameters:</span></dt>\n"
+ "<dd><code>T</code> - This is the first "
+ "type parameter.</dd>\n"
+ "<dd><code>V</code> - This is the second type "
+ "parameter.",
// Signature of method with type parameters
"public <T extends java.util.List,​V> "
+ "java.lang.String[] methodThatHasTypeParameters",
// Method that returns TypeParameters
"<td class=\"colFirst\"><code><a href=\"TypeParameters.html\" "
+ "title=\"type parameter in TypeParameters\">E</a>[]</code></td>\n"
+ "<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\">"
+ "<a href=\"#methodThatReturnsTypeParameterA(E%5B%5D)\">"
+ "methodThatReturnsTypeParameterA</a></span>​(<a href=\"TypeParameters.html\" "
+ "title=\"type parameter in TypeParameters\">E</a>[] e)</code>",
"<pre class=\"methodSignature\">public <a href=\"TypeParameters.html\" "
+ "title=\"type parameter in TypeParameters\">E</a>[] "
+ "methodThatReturnsTypeParameterA​(<a href=\"TypeParameters.html\" "
+ "title=\"type parameter in TypeParameters\">E</a>[] e)</pre>\n",
"<td class=\"colFirst\"><code><T extends java.lang.Object & java.lang.Comparable<? super T>>"
+ "<br>T</code></td>\n"
+ "<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\">"
+ "<a href=\"#methodtThatReturnsTypeParametersB(java.util.Collection)\">"
+ "methodtThatReturnsTypeParametersB</a></span>​(java.util.Collection<? extends T> coll)</code>",
"<div class=\"block\">Returns TypeParameters</div>\n",
// Method takes a TypeVariable
"<td class=\"colFirst\"><code><X extends java.lang.Throwable><br>"
+ "<a href=\"TypeParameters.html\" title=\"type parameter in TypeParameters\">E</a>"
+ "</code></td>\n"
+ "<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\">"
+ "<a href=\"#orElseThrow(java.util.function.Supplier)\">"
+ "orElseThrow</a></span>​(java.util.function.Supplier<? extends X> exceptionSupplier)</code>"
);
checkOutput("pkg/Wildcards.html", true,
// Wildcard testing.
"<a href=\"TypeParameters.html\" title=\"class in pkg\">"
+ "TypeParameters</a><? super java.lang.String> a",
"<a href=\"TypeParameters.html\" title=\"class in pkg\">"
+ "TypeParameters</a><? extends java.lang.StringBuffer> b",
"<a href=\"TypeParameters.html\" title=\"class in pkg\">"
+ "TypeParameters</a> c");
checkOutput(Output.OUT, true,
// Bad type parameter warnings.
"warning - @param argument "
+ "\"<BadClassTypeParam>\" is not a type parameter name.",
"warning - @param argument "
+ "\"<BadMethodTypeParam>\" is not a type parameter name.");
// Signature of subclass that has type parameters.
checkOutput("pkg/TypeParameterSubClass.html", true,
"<pre>public class <span class=\"typeNameLabel\">TypeParameterSubClass<T extends "
+ "java.lang.String></span>\n"
+ "extends "
+ "<a href=\"TypeParameterSuperClass.html\" title=\"class in pkg\">"
+ "TypeParameterSuperClass</a><T></pre>");
// Interface generic parameter substitution
// Signature of subclass that has type parameters.
checkOutput("pkg/TypeParameters.html", true,
"<dl>\n"
+ "<dt>All Implemented Interfaces:</dt>\n"
+ "<dd><code><a href=\"SubInterface.html\" title=\"interface in pkg\">"
+ "SubInterface</a><E></code>, <code><a href=\"SuperInterface.html\" "
+ "title=\"interface in pkg\">SuperInterface</a><E></code></dd>\n"
+ "</dl>");
checkOutput("pkg/SuperInterface.html", true,
"<dl>\n"
+ "<dt>All Known Subinterfaces:</dt>\n"
+ "<dd><code><a href=\"SubInterface.html\" title=\"interface in pkg\">"
+ "SubInterface</a><V></code></dd>\n"
+ "</dl>");
checkOutput("pkg/SubInterface.html", true,
"<dl>\n"
+ "<dt>All Superinterfaces:</dt>\n"
+ "<dd><code><a href=\"SuperInterface.html\" title=\"interface in pkg\">"
+ "SuperInterface</a><V></code></dd>\n"
+ "</dl>");
//==============================================================
// Handle multiple bounds.
//==============================================================
checkOutput("pkg/MultiTypeParameters.html", true,
"public <T extends java.lang.Number & java.lang.Runnable> T foo​(T t)");
//==============================================================
// Test Class-Use Documentation for Type Parameters.
//==============================================================
// ClassUseTest1: <T extends Foo & Foo2>
checkOutput("pkg2/class-use/Foo.html", true,
"<caption><span>Classes in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo.html\" title=\"class in pkg2\">"
+ "Foo</a></span><span class=\"tabEnd\"> </span></caption>",
"<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest1.html\" "
+ "title=\"class in pkg2\">ClassUseTest1</a><T extends "
+ "<a href=\"../Foo.html\" title=\"class in pkg2\">Foo"
+ "</a> & <a href=\"../Foo2.html\" title=\"interface in pkg2\">"
+ "Foo2</a>></span></code></th>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo.html\" title=\"class in "
+ "pkg2\">Foo</a></span><span class=\"tabEnd\"> </span></caption>",
"<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest1."
+ "</span><code><span class=\"memberNameLink\"><a href=\"../"
+ "ClassUseTest1.html#method(T)\">method</a></span>"
+ "​(T t)</code></th>",
"<caption><span>Fields in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo.html\" title=\"class in pkg2\">"
+ "Foo</a></span><span class=\"tabEnd\"> </span></caption>",
"td class=\"colFirst\"><code><a href=\"../"
+ "ParamTest.html\" title=\"class in pkg2\">ParamTest</a>"
+ "<<a href=\"../Foo.html\" title=\"class in pkg2\""
+ ">Foo</a>></code></td>"
);
checkOutput("pkg2/class-use/ParamTest.html", true,
"<caption><span>Fields in <a href=\"../"
+ "package-summary.html\">pkg2</a> declared as <a href=\"../"
+ "ParamTest.html\" title=\"class in pkg2\">ParamTest"
+ "</a></span><span class=\"tabEnd\"> </span></caption>",
"<td class=\"colFirst\"><code><a href=\"../"
+ "ParamTest.html\" title=\"class in pkg2\">ParamTest</a><<a "
+ "href=\"../Foo.html\" title=\"class in pkg2\">Foo</a"
+ ">></code></td>"
);
checkOutput("pkg2/class-use/Foo2.html", true,
"<caption><span>Classes in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo2.html\" title=\"interface "
+ "in pkg2\">Foo2</a></span><span class=\"tabEnd\"> "
+ "</span></caption>",
"<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest1.html\" "
+ "title=\"class in pkg2\">ClassUseTest1</a><T extends "
+ "<a href=\"../Foo.html\" title=\"class in pkg2\">Foo"
+ "</a> & <a href=\"../Foo2.html\" title=\"interface in pkg2\">"
+ "Foo2</a>></span></code></th>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo2.html\" title=\"interface "
+ "in pkg2\">Foo2</a></span><span class=\"tabEnd\"> "
+ "</span></caption>",
"<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">"
+ "ClassUseTest1.</span><code><span class=\"memberNameLink\"><a href=\"../"
+ "ClassUseTest1.html#method(T)\">method</a></span>"
+ "​(T t)</code></th>"
);
// ClassUseTest2: <T extends ParamTest<Foo3>>
checkOutput("pkg2/class-use/ParamTest.html", true,
"<caption><span>Classes in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../ParamTest.html\" title=\"class "
+ "in pkg2\">ParamTest</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest2.html\" "
+ "title=\"class in pkg2\">ClassUseTest2</a><T extends "
+ "<a href=\"../ParamTest.html\" title=\"class in pkg2\">"
+ "ParamTest</a><<a href=\"../Foo3.html\" title=\"class in pkg2\">"
+ "Foo3</a>>></span></code></th>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../ParamTest.html\" title=\"class "
+ "in pkg2\">ParamTest</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest2."
+ "</span><code><span class=\"memberNameLink\"><a href=\"../"
+ "ClassUseTest2.html#method(T)\">method</a></span>"
+ "​(T t)</code></th>",
"<caption><span>Fields in <a href=\"../"
+ "package-summary.html\">pkg2</a> declared as <a href=\"../"
+ "ParamTest.html\" title=\"class in pkg2\">ParamTest"
+ "</a></span><span class=\"tabEnd\"> </span></caption>",
"<td class=\"colFirst\"><code><a href=\"../"
+ "ParamTest.html\" title=\"class in pkg2\">ParamTest</a>"
+ "<<a href=\"../Foo.html\" title=\"class in pkg2\">"
+ "Foo</a>></code></td>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../ParamTest.html\" title=\"class "
+ "in pkg2\">ParamTest</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<td class=\"colFirst\"><code><T extends <a href=\"../"
+ "ParamTest.html\" title=\"class in pkg2\">ParamTest"
+ "</a><<a href=\"../Foo3.html\" title=\"class in "
+ "pkg2\">Foo3</a>>><br><a href=\"../"
+ "ParamTest.html\" title=\"class in pkg2\">ParamTest</a>"
+ "<<a href=\"../Foo3.html\" title=\"class in "
+ "pkg2\">Foo3</a>></code></td>"
);
checkOutput("pkg2/class-use/Foo3.html", true,
"<caption><span>Classes in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo3.html\" title=\"class in pkg2\">"
+ "Foo3</a></span><span class=\"tabEnd\"> </span></caption>",
"<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest2.html\" "
+ "title=\"class in pkg2\">ClassUseTest2</a><T extends "
+ "<a href=\"../ParamTest.html\" title=\"class in pkg2\">"
+ "ParamTest</a><<a href=\"../Foo3.html\" title=\"class in pkg2\">"
+ "Foo3</a>>></span></code></th>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo3.html\" title=\"class in "
+ "pkg2\">Foo3</a></span><span class=\"tabEnd\"> "
+ "</span></caption>",
"<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest2."
+ "</span><code><span class=\"memberNameLink\"><a href=\"../"
+ "ClassUseTest2.html#method(T)\">method</a></span>"
+ "​(T t)</code></th>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> that return types with "
+ "arguments of type <a href=\"../Foo3.html\" title"
+ "=\"class in pkg2\">Foo3</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<td class=\"colFirst\"><code><T extends <a href=\"../"
+ "ParamTest.html\" title=\"class in pkg2\">ParamTest</a><"
+ "<a href=\"../Foo3.html\" title=\"class in pkg2\">Foo3"
+ "</a>>><br><a href=\"../ParamTest.html\" "
+ "title=\"class in pkg2\">ParamTest</a><<a href=\"../"
+ "Foo3.html\" title=\"class in pkg2\">Foo3</a>></code></td>"
);
// ClassUseTest3: <T extends ParamTest2<List<? extends Foo4>>>
checkOutput("pkg2/class-use/ParamTest2.html", true,
"<caption><span>Classes in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../ParamTest2.html\" title=\"class "
+ "in pkg2\">ParamTest2</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest3.html\" "
+ "title=\"class in pkg2\">ClassUseTest3</a><T extends "
+ "<a href=\"../ParamTest2.html\" title=\"class in pkg2\">"
+ "ParamTest2</a><java.util.List<? extends "
+ "<a href=\"../Foo4.html\" title=\"class in pkg2\">"
+ "Foo4</a>>>></span></code></th>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../ParamTest2.html\" title=\"class "
+ "in pkg2\">ParamTest2</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest3"
+ ".</span><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest3."
+ "html#method(T)\">method</a></span>​(T t)</code></th>",
"<td class=\"colFirst\"><code><T extends <a href=\"../"
+ "ParamTest2.html\" title=\"class in pkg2\">"
+ "ParamTest2</a><java.util.List<? extends <a href=\".."
+ "/Foo4.html\" title=\"class in pkg2\">Foo4</a>>"
+ ">><br><a href=\"../ParamTest2.html\" "
+ "title=\"class in pkg2\">ParamTest2</a><java.util.List"
+ "<? extends <a href=\"../Foo4.html\" title=\""
+ "class in pkg2\">Foo4</a>>></code></td>"
);
checkOutput("pkg2/class-use/Foo4.html", true,
"<caption><span>Classes in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo4.html\" title=\"class in "
+ "pkg2\">Foo4</a></span><span class=\"tabEnd\"> "
+ "</span></caption>",
"<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest3.html\" "
+ "title=\"class in pkg2\">ClassUseTest3</a><T extends "
+ "<a href=\"../ParamTest2.html\" title=\"class in pkg2\">"
+ "ParamTest2</a><java.util.List<? extends "
+ "<a href=\"../Foo4.html\" title=\"class in pkg2\">"
+ "Foo4</a>>>></span></code></th>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type parameters of "
+ "type <a href=\"../Foo4.html\" title=\"class in "
+ "pkg2\">Foo4</a></span><span class=\"tabEnd\"> </span></caption>",
"<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest3."
+ "</span><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest3."
+ "html#method(T)\">method</a></span>​(T t)</code>"
+ "</th>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg2</a> that return types with "
+ "arguments of type <a href=\"../Foo4.html\" "
+ "title=\"class in pkg2\">Foo4</a></span><span class=\""
+ "tabEnd\"> </span></caption>",
"<td class=\"colFirst\"><code><T extends <a href=\"../"
+ "ParamTest2.html\" title=\"class in pkg2\">"
+ "ParamTest2</a><java.util.List<? extends <a href=\".."
+ "/Foo4.html\" title=\"class in pkg2\">Foo4</a>>"
+ ">><br><a href=\"../ParamTest2.html\" "
+ "title=\"class in pkg2\">ParamTest2</a><java.util.List"
+ "<? extends <a href=\"../Foo4.html\" title=\""
+ "class in pkg2\">Foo4</a>>></code></td>"
);
// Type parameters in constructor and method args
checkOutput("pkg2/class-use/Foo4.html", true,
"<caption><span>Method parameters in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type arguments of "
+ "type <a href=\"../Foo4.html\" title=\"class in "
+ "pkg2\">Foo4</a></span><span class=\"tabEnd\"> "
+ "</span></caption>\n"
+ "<tr>\n"
+ "<th class=\"colFirst\" scope=\"col\">Modifier and Type</th>\n"
+ "<th class=\"colSecond\" scope=\"col\">Method</th>\n"
+ "<th class=\"colLast\" scope=\"col\">Description</th>\n"
+ "</tr>\n"
+ "<tbody>\n"
+ "<tr class=\"altColor\">\n"
+ "<td class=\"colFirst\"><code>void</code></td>\n"
+ "<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest3."
+ "</span><code><span class=\"memberNameLink\"><a href=\"../ClassUseTest3."
+ "html#method(java.util.Set)\">method</a></span>​(java."
+ "util.Set<<a href=\"../Foo4.html\" title=\""
+ "class in pkg2\">Foo4</a>> p)</code></th>",
"<caption><span>Constructor parameters in <a href=\"../"
+ "package-summary.html\">pkg2</a> with type arguments "
+ "of type <a href=\"../Foo4.html\" title=\"class in "
+ "pkg2\">Foo4</a></span><span class=\"tabEnd\"> "
+ "</span></caption>"
);
//=================================
// TYPE PARAMETER IN INDEX
//=================================
checkOutput("index-all.html", true,
"<span class=\"memberNameLink\"><a href=\"pkg2/Foo.html#method(java.util.Vector)\">"
+ "method(Vector<Object>)</a></span>"
);
// TODO: duplicate of previous case; left in delibarately for now to simplify comparison testing
//=================================
// TYPE PARAMETER IN INDEX
//=================================
checkOutput("index-all.html", true,
"<span class=\"memberNameLink\"><a href=\"pkg2/Foo.html#method(java.util.Vector)\">"
+ "method(Vector<Object>)</a></span>"
);
// No type parameters in class frame.
checkOutput("allclasses-frame.html", false,
"<a href=\"../pkg/TypeParameters.html\" title=\"class in pkg\">"
+ "TypeParameters</a><<a href=\"../pkg/TypeParameters.html\" "
+ "title=\"type parameter in TypeParameters\">E</a>>"
);
}
//=================================
// VAR ARG TESTING
//=================================
void checkVarArgs() {
checkOutput("pkg/VarArgs.html", true,
"(int... i)",
"(int[][]... i)",
"(int[]...)",
"<a href=\"TypeParameters.html\" title=\"class in pkg\">"
+ "TypeParameters</a>... t");
}
//=================================
// ANNOTATION TYPE TESTING
//=================================
void checkAnnotationTypes() {
checkOutput("pkg/AnnotationType.html", true,
// Make sure the summary links are correct.
"<li>Summary: </li>\n"
+ "<li>Field | </li>\n"
+ "<li><a href=\"#annotation.type.required.element.summary\">"
+ "Required</a> | </li>\n"
+ "<li>"
+ "<a href=\"#annotation.type.optional.element.summary\">Optional</a></li>",
// Make sure the detail links are correct.
"<li>Detail: </li>\n"
+ "<li>Field | </li>\n"
+ "<li><a href=\"#annotation.type.element.detail\">Element</a></li>",
// Make sure the heading is correct.
"Annotation Type AnnotationType</h2>",
// Make sure the signature is correct.
"public @interface <span class=\"memberNameLabel\">AnnotationType</span>",
// Make sure member summary headings are correct.
"<h3>Required Element Summary</h3>",
"<h3>Optional Element Summary</h3>",
// Make sure element detail heading is correct
"Element Detail",
// Make sure default annotation type value is printed when necessary.
"<dl>\n"
+ "<dt>Default:</dt>\n"
+ "<dd>\"unknown\"</dd>\n"
+ "</dl>");
}
//=================================
// ANNOTATION TYPE USAGE TESTING
//=================================
void checkAnnotationTypeUsage() {
checkOutput("pkg/package-summary.html", true,
// PACKAGE
"<a href=\"AnnotationType.html\" title=\"annotation in pkg\">@AnnotationType</a>(<a href=\"AnnotationType.html#optional()\">optional</a>=\"Package Annotation\",\n"
+ " <a href=\"AnnotationType.html#required()\">required</a>=1994)");
checkOutput("pkg/AnnotationTypeUsage.html", true,
// CLASS
"<pre><a href=\"AnnotationType.html\" "
+ "title=\"annotation in pkg\">@AnnotationType</a>("
+ "<a href=\"AnnotationType.html#optional()\">optional</a>"
+ "=\"Class Annotation\",\n"
+ " <a href=\"AnnotationType.html#required()\">"
+ "required</a>=1994)\n"
+ "public class <span class=\"typeNameLabel\">"
+ "AnnotationTypeUsage</span>\n"
+ "extends java.lang.Object</pre>",
// FIELD
"<pre><a href=\"AnnotationType.html\" "
+ "title=\"annotation in pkg\">@AnnotationType</a>("
+ "<a href=\"AnnotationType.html#optional()\">optional</a>"
+ "=\"Field Annotation\",\n"
+ " <a href=\"AnnotationType.html#required()\">"
+ "required</a>=1994)\n"
+ "public int field</pre>",
// CONSTRUCTOR
"<pre><a href=\"AnnotationType.html\" "
+ "title=\"annotation in pkg\">@AnnotationType</a>("
+ "<a href=\"AnnotationType.html#optional()\">optional</a>"
+ "=\"Constructor Annotation\",\n"
+ " <a href=\"AnnotationType.html#required()\">"
+ "required</a>=1994)\n"
+ "public AnnotationTypeUsage()</pre>",
// METHOD
"<pre class=\"methodSignature\"><a href=\"AnnotationType.html\" "
+ "title=\"annotation in pkg\">@AnnotationType</a>("
+ "<a href=\"AnnotationType.html#optional()\">optional</a>"
+ "=\"Method Annotation\",\n"
+ " <a href=\"AnnotationType.html#required()\">"
+ "required</a>=1994)\n"
+ "public void method()</pre>",
// METHOD PARAMS
"<pre class=\"methodSignature\">public void methodWithParams​("
+ "<a href=\"AnnotationType.html\" title=\"annotation in pkg\">"
+ "@AnnotationType</a>(<a href=\"AnnotationType.html#optional()\">"
+ "optional</a>=\"Parameter Annotation\",<a "
+ "href=\"AnnotationType.html#required()\">required</a>=1994)\n"
+ " int documented,\n"
+ " int undocmented)</pre>",
// CONSTRUCTOR PARAMS
"<pre>public AnnotationTypeUsage​(<a "
+ "href=\"AnnotationType.html\" title=\"annotation in pkg\">"
+ "@AnnotationType</a>(<a href=\"AnnotationType.html#optional()\">"
+ "optional</a>=\"Constructor Param Annotation\",<a "
+ "href=\"AnnotationType.html#required()\">required</a>=1994)\n"
+ " int documented,\n"
+ " int undocmented)</pre>");
//=================================
// Annotatation Type Usage
//=================================
checkOutput("pkg/class-use/AnnotationType.html", true,
"<caption><span>Packages with annotations of type <a href=\""
+ "../AnnotationType.html\" title=\"annotation in pkg\">"
+ "AnnotationType</a></span><span class=\"tabEnd\"> "
+ "</span></caption>",
"<caption><span>Classes in <a href=\"../"
+ "package-summary.html\">pkg</a> with annotations of type "
+ "<a href=\"../AnnotationType.html\" title=\""
+ "annotation in pkg\">AnnotationType</a></span><span class"
+ "=\"tabEnd\"> </span></caption>",
"<caption><span>Fields in <a href=\"../"
+ "package-summary.html\">pkg</a> with annotations of type "
+ "<a href=\"../AnnotationType.html\" title=\"annotation "
+ "in pkg\">AnnotationType</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<caption><span>Methods in <a href=\"../"
+ "package-summary.html\">pkg</a> with annotations of type "
+ "<a href=\"../AnnotationType.html\" title=\"annotation "
+ "in pkg\">AnnotationType</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<caption><span>Method parameters in <a href=\"../"
+ "package-summary.html\">pkg</a> with annotations of type "
+ "<a href=\"../AnnotationType.html\" title=\"annotation "
+ "in pkg\">AnnotationType</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<caption><span>Constructors in <a href=\"../"
+ "package-summary.html\">pkg</a> with annotations of type "
+ "<a href=\"../AnnotationType.html\" title=\"annotation "
+ "in pkg\">AnnotationType</a></span><span class=\"tabEnd\">"
+ " </span></caption>",
"<caption><span>Constructor parameters in <a href=\"../"
+ "package-summary.html\">pkg</a> with annotations of "
+ "type <a href=\"../AnnotationType.html\" title=\""
+ "annotation in pkg\">AnnotationType</a></span><span class=\""
+ "tabEnd\"> </span></caption>"
);
//==============================================================
// ANNOTATION TYPE USAGE TESTING (When @Documented is omitted)
//===============================================================
checkOutput("pkg/AnnotationTypeUsage.html", false,
// CLASS
"<a href=\"AnnotationTypeUndocumented.html\" title=\"annotation in pkg\">@AnnotationTypeUndocumented</a>(<a href=\"AnnotationType.html#optional\">optional</a>=\"Class Annotation\",\n"
+ " <a href=\"AnnotationType.html#required\">required</a>=1994)\n"
+ "public class <span class=\"typeNameLabel\">AnnotationTypeUsage</span></dt><dt>extends java.lang.Object</dt>",
// FIELD
"<a href=\"AnnotationTypeUndocumented.html\" title=\"annotation in pkg\">@AnnotationTypeUndocumented</a>(<a href=\"AnnotationType.html#optional\">optional</a>=\"Field Annotation\",\n"
+ " <a href=\"AnnotationType.html#required\">required</a>=1994)\n"
+ "public int <span class=\"memberNameLabel\">field</span>",
// CONSTRUCTOR
"<a href=\"AnnotationTypeUndocumented.html\" title=\"annotation in pkg\">@AnnotationTypeUndocumented</a>(<a href=\"AnnotationType.html#optional\">optional</a>=\"Constructor Annotation\",\n"
+ " <a href=\"AnnotationType.html#required\">required</a>=1994)\n"
+ "public <span class=\"typeNameLabel\">AnnotationTypeUsage</span>()",
// METHOD
"<a href=\"AnnotationTypeUndocumented.html\" title=\"annotation in pkg\">@AnnotationTypeUndocumented</a>(<a href=\"AnnotationType.html#optional\">optional</a>=\"Method Annotation\",\n"
+ " <a href=\"AnnotationType.html#required\">required</a>=1994)\n"
+ "public void <span class=\"memberNameLabel\">method</span>()");
//=================================
// Make sure annotation types do not
// trigger this warning.
//=================================
checkOutput(Output.OUT, false,
"Internal error: package sets don't match: [] with: null");
//=================================
// ANNOTATION TYPE USAGE TESTING (All Different Types).
//=================================
checkOutput("pkg1/B.html", true,
// Integer
"<a href=\"A.html#d()\">d</a>=3.14,",
// Double
"<a href=\"A.html#d()\">d</a>=3.14,",
// Boolean
"<a href=\"A.html#b()\">b</a>=true,",
// String
"<a href=\"A.html#s()\">s</a>=\"sigh\",",
// Class
"<a href=\"A.html#c()\">c</a>=<a href=\"../pkg2/Foo.html\" title=\"class in pkg2\">Foo.class</a>,",
// Bounded Class
"<a href=\"A.html#w()\">w</a>=<a href=\"../pkg/TypeParameterSubClass.html\" title=\"class in pkg\">TypeParameterSubClass.class</a>,",
// Enum
"<a href=\"A.html#e()\">e</a>=<a href=\"../pkg/Coin.html#Penny\">Penny</a>,",
// Annotation Type
"<a href=\"A.html#a()\">a</a>=<a href=\"../pkg/AnnotationType.html\" title=\"annotation in pkg\">@AnnotationType</a>(<a href=\"../pkg/AnnotationType.html#optional()\">optional</a>=\"foo\",<a href=\"../pkg/AnnotationType.html#required()\">required</a>=1994),",
// String Array
"<a href=\"A.html#sa()\">sa</a>={\"up\",\"down\"},",
// Primitive
"<a href=\"A.html#primitiveClassTest()\">primitiveClassTest</a>=boolean.class,");
// XXX: Add array test case after this if fixed:
//5020899: Incorrect internal representation of class-valued annotation elements
// Make sure that annotations are surrounded by <pre> and </pre>
checkOutput("pkg1/B.html", true,
"<pre><a href=\"A.html\" title=\"annotation in pkg1\">@A</a>",
"public interface <span class=\"typeNameLabel\">B</span></pre>");
}
}