The TestNewLanguageFeatures.java Java example source code
/*
* Copyright (c) 2003, 2013, 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
* @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/
* @build JavadocTester TestNewLanguageFeatures
* @run main TestNewLanguageFeatures
*/
public class TestNewLanguageFeatures extends JavadocTester {
//Test information.
private static final String BUG_ID = "4789689-4905985-4927164-4827184-4993906";
//Javadoc arguments.
private static final String[] ARGS = new String[] {
"-Xdoclint:none", "-d", BUG_ID, "-use", "-source", "1.5", "-sourcepath", SRC_DIR, "pkg", "pkg1", "pkg2"
};
//Input for string search tests.
private static final String[][] TEST =
{
//=================================
// ENUM TESTING
//=================================
//Make sure enum header is correct.
{BUG_ID + FS + "pkg" + FS + "Coin.html", "Enum Coin</h2>"},
//Make sure enum signature is correct.
{BUG_ID + FS + "pkg" + FS + "Coin.html", "<pre>public enum " +
"<span class=\"typeNameLabel\">Coin" + NL +
"extends java.lang.Enum<<a href=\"../pkg/Coin.html\" " +
"title=\"enum in pkg\">Coin</a>>"
},
//Check for enum constant section
{BUG_ID + FS + "pkg" + FS + "Coin.html", "<caption>
Enum Constants" +
"</span> "},
//Detail for enum constant
{BUG_ID + FS + "pkg" + FS + "Coin.html",
"<span class=\"memberNameLink\">Dime"},
//Automatically insert documentation for values() and valueOf().
{BUG_ID + FS + "pkg" + FS + "Coin.html",
"Returns an array containing the constants of this enum type,"},
{BUG_ID + FS + "pkg" + FS + "Coin.html",
"Returns the enum constant of this type with the specified name"},
{BUG_ID + FS + "pkg" + FS + "Coin.html", "for (Coin c : Coin.values())"},
{BUG_ID + FS + "pkg" + FS + "Coin.html", "Overloaded valueOf() method has correct documentation."},
{BUG_ID + FS + "pkg" + FS + "Coin.html", "Overloaded values method has correct documentation."},
//=================================
// TYPE PARAMETER TESTING
//=================================
//Make sure the header is correct.
{BUG_ID + FS + "pkg" + FS + "TypeParameters.html",
"Class TypeParameters<E></h2>"},
//Check class type parameters section.
{BUG_ID + FS + "pkg" + FS + "TypeParameters.html",
"<dt>
Type Parameters:" + NL + "
E - " +
"the type parameter for this class."},
//Type parameters in @see/@link
{BUG_ID + FS + "pkg" + FS + "TypeParameters.html",
"<dl>" + NL + "See Also:" + NL + "
" +
"<a href=\"../pkg/TypeParameters.html\" title=\"class in pkg\">" +
"<code>TypeParameters" + NL + ""},
//Method that uses class type parameter.
{BUG_ID + FS + "pkg" + FS + "TypeParameters.html",
"(<a href=\"../pkg/TypeParameters.html\" title=\"type " +
"parameter in TypeParameters\">E</a> param)"},
//Method type parameter section.
{BUG_ID + FS + "pkg" + FS + "TypeParameters.html",
"<span class=\"paramLabel\">Type Parameters:" + NL + "
T - This is the first " +
"type parameter.</dd>" + NL + "V - This is the second type " +
"parameter."},
//Signature of method with type parameters
{BUG_ID + FS + "pkg" + FS + "TypeParameters.html",
"public <T extends java.util.List,V> " +
"java.lang.String[] methodThatHasTypeParameters"},
//Wildcard testing.
{BUG_ID + FS + "pkg" + FS + "Wildcards.html",
"<a href=\"../pkg/TypeParameters.html\" title=\"class in pkg\">" +
"TypeParameters</a><? super java.lang.String> a"},
{BUG_ID + FS + "pkg" + FS + "Wildcards.html",
"<a href=\"../pkg/TypeParameters.html\" title=\"class in pkg\">" +
"TypeParameters</a><? extends java.lang.StringBuffer> b"},
{BUG_ID + FS + "pkg" + FS + "Wildcards.html",
"<a href=\"../pkg/TypeParameters.html\" title=\"class in pkg\">" +
"TypeParameters</a> c"},
//Bad type parameter warnings.
{WARNING_OUTPUT, "warning - @param argument " +
"\"<BadClassTypeParam>\" is not a type parameter name."},
{WARNING_OUTPUT, "warning - @param argument " +
"\"<BadMethodTypeParam>\" is not a type parameter name."},
//Signature of subclass that has type parameters.
{BUG_ID + FS + "pkg" + FS + "TypeParameterSubClass.html",
"<pre>public class TypeParameterSubClass<T extends " +
"java.lang.String></span>" + NL + "extends " +
"<a href=\"../pkg/TypeParameterSuperClass.html\" title=\"class in pkg\">" +
"TypeParameterSuperClass</a><T>"},
//Interface generic parameter substitution
//Signature of subclass that has type parameters.
{BUG_ID + FS + "pkg" + FS + "TypeParameters.html",
"<dl>" + NL + "All Implemented Interfaces:" + NL +
"<dd>" +
"SubInterface</a><E>, <E>" + NL +
"</dl>"},
{BUG_ID + FS + "pkg" + FS + "SuperInterface.html",
"<dl>" + NL + "All Known Subinterfaces:" + NL +
"<dd>
" +
"SubInterface</a><V>" + NL + ""},
{BUG_ID + FS + "pkg" + FS + "SubInterface.html",
"<dl>" + NL + "All Superinterfaces:" + NL +
"<dd>" +
"SuperInterface</a><V>" + NL + ""},
//=================================
// VAR ARG TESTING
//=================================
{BUG_ID + FS + "pkg" + FS + "VarArgs.html", "(int... i)"},
{BUG_ID + FS + "pkg" + FS + "VarArgs.html", "(int[][]... i)"},
{BUG_ID + FS + "pkg" + FS + "VarArgs.html", "-int:A...-"},
{BUG_ID + FS + "pkg" + FS + "VarArgs.html",
"<a href=\"../pkg/TypeParameters.html\" title=\"class in pkg\">" +
"TypeParameters</a>... t"},
//=================================
// ANNOTATION TYPE TESTING
//=================================
//Make sure the summary links are correct.
{BUG_ID + FS + "pkg" + FS + "AnnotationType.html",
"<li>Summary: " + NL + "Field | " + NL +
"<li>" +
"Required</a> | " + NL + "" +
"<a href=\"#annotation.type.optional.element.summary\">Optional"},
//Make sure the detail links are correct.
{BUG_ID + FS + "pkg" + FS + "AnnotationType.html",
"<li>Detail: " + NL + "
Field | " + NL +
"<li>
Element"},
//Make sure the heading is correct.
{BUG_ID + FS + "pkg" + FS + "AnnotationType.html",
"Annotation Type AnnotationType</h2>"},
//Make sure the signature is correct.
{BUG_ID + FS + "pkg" + FS + "AnnotationType.html",
"public @interface <span class=\"memberNameLabel\">AnnotationType"},
//Make sure member summary headings are correct.
{BUG_ID + FS + "pkg" + FS + "AnnotationType.html",
"<h3>Required Element Summary"},
{BUG_ID + FS + "pkg" + FS + "AnnotationType.html",
"<h3>Optional Element Summary"},
//Make sure element detail heading is correct
{BUG_ID + FS + "pkg" + FS + "AnnotationType.html",
"Element Detail"},
//Make sure default annotation type value is printed when necessary.
{BUG_ID + FS + "pkg" + FS + "AnnotationType.html",
"<dl>" + NL + "
Default:" + NL + "
\"unknown\"" + NL +
"</dl>"},
//=================================
// ANNOTATION TYPE USAGE TESTING
//=================================
//PACKAGE
{BUG_ID + FS + "pkg" + FS + "package-summary.html",
"<a href=\"../pkg/AnnotationType.html\" title=\"annotation in pkg\">@AnnotationType(
optional=\"Package Annotation\"," + NL +
" <a href=\"../pkg/AnnotationType.html#required--\">required=1994)"},
//CLASS
{BUG_ID + FS + "pkg" + FS + "AnnotationTypeUsage.html",
"<pre>
(" +
"<a href=\"../pkg/AnnotationType.html#optional--\">optional" +
"=\"Class Annotation\"," + NL +
" <a href=\"../pkg/AnnotationType.html#required--\">" +
"required</a>=1994)" + NL + "public class
" +
"AnnotationTypeUsage</span>" + NL + "extends java.lang.Object"},
//FIELD
{BUG_ID + FS + "pkg" + FS + "AnnotationTypeUsage.html",
"<pre>(" +
"<a href=\"../pkg/AnnotationType.html#optional--\">optional" +
"=\"Field Annotation\"," + NL +
" <a href=\"../pkg/AnnotationType.html#required--\">" +
"required</a>=1994)" + NL + "public int field"},
//CONSTRUCTOR
{BUG_ID + FS + "pkg" + FS + "AnnotationTypeUsage.html",
"<pre>(" +
"<a href=\"../pkg/AnnotationType.html#optional--\">optional" +
"=\"Constructor Annotation\"," + NL +
" <a href=\"../pkg/AnnotationType.html#required--\">" +
"required</a>=1994)" + NL + "public AnnotationTypeUsage()"},
//METHOD
{BUG_ID + FS + "pkg" + FS + "AnnotationTypeUsage.html",
"<pre>(" +
"<a href=\"../pkg/AnnotationType.html#optional--\">optional" +
"=\"Method Annotation\"," + NL +
" <a href=\"../pkg/AnnotationType.html#required--\">" +
"required</a>=1994)" + NL + "public void method()"},
//METHOD PARAMS
{BUG_ID + FS + "pkg" + FS + "AnnotationTypeUsage.html",
"<pre>public void methodWithParams(" +
"<a href=\"../pkg/AnnotationType.html\" title=\"annotation in pkg\">" +
"@AnnotationType</a>(" +
"optional</a>=\"Parameter Annotation\",=1994)" + NL +
" int documented," + NL +
" int undocmented)</pre>"},
//CONSTRUCTOR PARAMS
{BUG_ID + FS + "pkg" + FS + "AnnotationTypeUsage.html",
"<pre>public AnnotationTypeUsage(" +
"optional</a>=\"Constructor Param Annotation\",=1994)" + NL +
" int documented," + NL +
" int undocmented)</pre>"},
//=================================
// ANNOTATION TYPE USAGE TESTING (All Different Types).
//=================================
//Integer
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#d--\">d=3.14,"},
//Double
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#d--\">d=3.14,"},
//Boolean
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#b--\">b=true,"},
//String
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#s--\">s=\"sigh\","},
//Class
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#c--\">c=Foo.class,"},
//Bounded Class
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#w--\">w=TypeParameterSubClass.class,"},
//Enum
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#e--\">e=Penny,"},
//Annotation Type
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#a--\">a=@AnnotationType(optional=\"foo\",required=1994),"},
//String Array
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#sa--\">sa={\"up\",\"down\"},"},
//Primitive
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<a href=\"../pkg1/A.html#primitiveClassTest--\">primitiveClassTest=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
{BUG_ID + FS + "pkg1" + FS + "B.html",
"<pre>@A"},
{BUG_ID + FS + "pkg1" + FS + "B.html",
"public interface <span class=\"typeNameLabel\">B"},
//==============================================================
// Handle multiple bounds.
//==============================================================
{BUG_ID + FS + "pkg" + FS + "MultiTypeParameters.html",
"public <T extends java.lang.Number & java.lang.Runnable> T foo(T t)"},
//==============================================================
// Test Class-Use Documenation for Type Parameters.
//==============================================================
//ClassUseTest1: <T extends Foo & Foo2>
{BUG_ID + FS + "pkg2" + FS + "class-use" + FS + "Foo.html",
"<caption>
Classes in with type parameters of " +
"type <a href=\"../../pkg2/Foo.html\" title=\"class in pkg2\">" +
"Foo</a> "
},
{BUG_ID + FS + "pkg2" + FS + "class-use" + FS + "Foo.html",
"<td class=\"colLast\">
<T extends " +
"<a href=\"../../pkg2/Foo.html\" title=\"class in pkg2\">Foo" +
"</a> & " +
"Foo2</a>> 
The search page
Other Java source code examples at this package level
Click here to learn more about this project