Java example source code file (MethodReturns.java)

This example Java source code file (MethodReturns.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

ginner, gouter, method_return, object, set, string, tadescription, tadescriptions, test

The MethodReturns.java Java example source code

/*
 * Copyright (c) 2009, 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.
 */

import static com.sun.tools.classfile.TypeAnnotation.TargetType.*;

/*
 * @test
 * @summary Test population of reference info for method return
 * @compile -g Driver.java ReferenceInfoUtil.java MethodReturns.java
 * @run main Driver MethodReturns
 */
public class MethodReturns {

    // Method returns
    @TADescription(annotation = "TA", type = METHOD_RETURN)
    public String methodReturnAsPrimitive() {
        return "@TA int test() { return 0; }";
    }

    @TADescription(annotation = "TA", type = METHOD_RETURN)
    public String methodReturnAsObject() {
        return "@TA Object test() { return null; }";
    }

    @TADescriptions({
        @TADescription(annotation = "TA", type = METHOD_RETURN),
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 3, 0 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 3, 1 }),
        @TADescription(annotation = "TD", type = METHOD_RETURN,
                genericLocation = { 3, 1, 3, 0 })
    })
    public String methodReturnAsParametrized() {
        return "@TA Map<@TB String, @TC List<@TD String>> test() { return null; }";
    }

    @TADescriptions({
        @TADescription(annotation = "TA", type = METHOD_RETURN),
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 0, 0 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 0, 0, 0, 0 })
    })
    public String methodReturnAsArray() {
        return "@TC String @TA [] @TB [] test() { return null; }";
    }

    @TADescriptions({
        @TADescription(annotation = "TA", type = METHOD_RETURN),
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 0, 0 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 0, 0, 0, 0 })
    })
    public String methodReturnAsArrayOld() {
        return "@TC String test() @TA [] @TB [] { return null; }";
    }

    @TADescriptions({})
    public String methodWithDeclarationAnnotation() {
        return "@Decl String test() { return null; }";
    }

    @TADescriptions({})
    public String methodWithNoTargetAnno() {
        return "@A String test() { return null; }";
    }

    // Smoke tests
    @TADescription(annotation = "TA", type = METHOD_RETURN)
    public String interfaceMethodReturnAsObject() {
        return "interface Test { @TA Object test(); }";
    }

    @TADescription(annotation = "TA", type = METHOD_RETURN)
    public String abstractMethodReturnAsObject() {
        return "abstract class Test { abstract @TA Object test(); }";
    }


    @TADescriptions({
        @TADescription(annotation = "TA", type = METHOD_RETURN),
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 3, 0 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 3, 1 }),
        @TADescription(annotation = "TD", type = METHOD_RETURN,
                genericLocation = { 3, 1, 3, 0 })
    })
    public String interfaceMethodReturnAsParametrized() {
        return "interface Test { @TA Map<@TB String, @TC List<@TD String>> test(); }";
    }

    @TADescriptions({
        @TADescription(annotation = "TA", type = METHOD_RETURN,
                genericLocation = { 3, 0 }),
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0 }),
        @TADescription(annotation = "TD", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0, 3, 0 }),
        @TADescription(annotation = "TE", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0, 3, 1 }),
        @TADescription(annotation = "TF", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0, 3, 1, 2, 0 })
    })
    public String methodReturnAsNestedWildcard() {
        return "Set<@TA ? extends @TB GOuter> entrySet() { return null; }";
    }

    @TADescriptions({
        @TADescription(annotation = "TA", type = METHOD_RETURN,
                genericLocation = { 3, 0, 1, 0, 3, 0 }),
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 3, 0, 1, 0, 3, 1 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 3, 0, 1, 0, 3, 1, 2, 0 })
    })
    public String methodReturnAsNestedWildcard2() {
        return "class GOuter<X, Y> { class GInner {} } " +
                "class Test<K> { Set.GInner<@TA K, @TB ? extends @TC Object>> entrySet() { return null; } }";
    }

    @TADescriptions({
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0 }),
    })
    public String methodReturnAsNestedWildcard3() {
        return "Set<? extends @TB GOuter> entrySet() { return null; }";
    }

    @TADescriptions({
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0 }),
    })
    public String methodReturnAsNestedWildcard4() {
        return "Set<? extends GOuter> entrySet() { return null; }";
    }

    @TADescriptions({
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0 }),
    })
    public String methodReturnAsNestedWildcard5() {
        return "Set<? extends @TB Outer. @TC Inner> entrySet() { return null; }";
    }

    @TADescriptions({
        @TADescription(annotation = "TA", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0, 3, 0 }),
        @TADescription(annotation = "TB", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0, 3, 1 }),
        @TADescription(annotation = "TC", type = METHOD_RETURN,
                genericLocation = { 3, 0, 2, 0, 1, 0 }),
    })
    public String methodReturnAsNestedWildcard6() {
        return "Set<? extends GOuter> entrySet() { return null; }";
    }

}