langtools/test/tools/javac/processing/model/element/TestExecutableElement.java
author darcy
Wed, 03 Apr 2013 12:27:12 -0700
changeset 16803 3bdc22a32b0e
parent 14956 185bd7c693d8
child 21006 534673718919
permissions -rw-r--r--
8011052: Add DEFAULT to javax.lang.model.Modifier Reviewed-by: abuckley, jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14956
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
     1
/*
16803
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
     2
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
14956
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
     4
 *
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
     7
 * published by the Free Software Foundation.
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
     8
 *
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    13
 * accompanied this code).
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    14
 *
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    18
 *
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    21
 * questions.
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    22
 */
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    23
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    24
/*
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    25
 * @test
16803
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    26
 * @bug 8005046 8011052
14956
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    27
 * @summary Test basic properties of javax.lang.element.Element
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    28
 * @author  Joseph D. Darcy
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    29
 * @library /tools/javac/lib
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    30
 * @build   JavacTestingAbstractProcessor TestExecutableElement
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    31
 * @compile -processor TestExecutableElement -proc:only TestExecutableElement.java
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    32
 */
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    33
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    34
import java.lang.annotation.*;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    35
import java.util.Formatter;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    36
import java.util.Set;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    37
import java.util.Objects;
16803
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    38
import java.util.regex.*;
14956
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    39
import javax.annotation.processing.*;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    40
import javax.lang.model.SourceVersion;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    41
import static javax.lang.model.SourceVersion.*;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    42
import javax.lang.model.element.*;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    43
import javax.lang.model.util.*;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    44
import static javax.lang.model.util.ElementFilter.*;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    45
import static javax.tools.Diagnostic.Kind.*;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    46
import static javax.tools.StandardLocation.*;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    47
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    48
/**
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    49
 * Test some basic workings of javax.lang.element.ExecutableElement
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    50
 */
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    51
public class TestExecutableElement extends JavacTestingAbstractProcessor implements ProviderOfDefault {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    52
    @IsDefault(false)
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    53
    public boolean process(Set<? extends TypeElement> annotations,
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    54
                           RoundEnvironment roundEnv) {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    55
        int errors = 0;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    56
        if (!roundEnv.processingOver()) {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    57
            boolean hasRun = false;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    58
            for (Element element : roundEnv.getRootElements()) {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    59
                for (ExecutableElement method : methodsIn(element.getEnclosedElements())) {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    60
                    hasRun = true;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    61
                    errors += checkIsDefault(method);
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    62
                }
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    63
            }
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    64
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    65
            if (!hasRun) {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    66
                messager.printMessage(ERROR, "No test cases run; test fails.");
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    67
            }
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    68
        }
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    69
        return true;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    70
    }
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    71
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    72
    @IsDefault(false)
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    73
    int checkIsDefault(ExecutableElement method) {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    74
        System.out.println("Testing " + method);
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    75
        IsDefault expectedIsDefault = method.getAnnotation(IsDefault.class);
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    76
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    77
        boolean expectedDefault = (expectedIsDefault != null) ?
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    78
            expectedIsDefault.value() :
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    79
            false;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    80
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    81
        boolean methodIsDefault = method.isDefault();
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
    82
16803
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    83
        if (expectedDefault) {
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    84
            if (!method.getModifiers().contains(Modifier.DEFAULT)) {
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    85
                messager.printMessage(ERROR,
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    86
                                      "Modifier \"default\" not present as expected.",
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    87
                                      method);
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    88
            }
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    89
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    90
            // Check printing output
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    91
            java.io.Writer stringWriter = new java.io.StringWriter();
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    92
            eltUtils.printElements(stringWriter, method);
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    93
            Pattern p = Pattern.compile(expectedIsDefault.expectedTextRegex(), Pattern.DOTALL);
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    94
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    95
            if (! p.matcher(stringWriter.toString()).matches()) {
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    96
                messager.printMessage(ERROR,
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    97
                                      new Formatter().format("Unexpected printing ouptput:%n\tgot %s,%n\texpected pattern %s.",
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    98
                                                             stringWriter.toString(),
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
    99
                                                             expectedIsDefault.expectedTextRegex()).toString(),
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   100
                                      method);
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   101
            }
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   102
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   103
            System.out.println("\t" + stringWriter.toString());
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   104
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   105
        } else {
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   106
            if (method.getModifiers().contains(Modifier.DEFAULT)) {
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   107
                messager.printMessage(ERROR,
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   108
                                      "Modifier \"default\" present when not expected.",
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   109
                                      method);
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   110
            }
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   111
        }
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   112
14956
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   113
        if (methodIsDefault != expectedDefault) {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   114
            messager.printMessage(ERROR,
16803
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   115
                                  new Formatter().format("Unexpected Executable.isDefault result: got ``%s'', expected ``%s''.",
14956
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   116
                                                         expectedDefault,
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   117
                                                         methodIsDefault).toString(),
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   118
                                  method);
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   119
            return 1;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   120
        }
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   121
        return 0;
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   122
    }
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   123
}
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   124
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   125
/**
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   126
 * Expected value of the ExecutableElement.isDefault method.
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   127
 */
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   128
@Retention(RetentionPolicy.RUNTIME)
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   129
@Target(ElementType.METHOD)
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   130
@interface IsDefault {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   131
    boolean value();
16803
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   132
    String expectedTextRegex() default "";
14956
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   133
}
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   134
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   135
/**
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   136
 * Test interface to provide a default method.
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   137
 */
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   138
interface ProviderOfDefault {
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   139
    @IsDefault(false)
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   140
    boolean process(Set<? extends TypeElement> annotations,
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   141
                    RoundEnvironment roundEnv);
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   142
16803
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   143
    @IsDefault(value=true, expectedTextRegex="\\s*@IsDefault\\(.*\\)\\s*default strictfp void quux\\(\\);\\s*$")
3bdc22a32b0e 8011052: Add DEFAULT to javax.lang.model.Modifier
darcy
parents: 14956
diff changeset
   144
    default strictfp void quux() {};
14956
185bd7c693d8 8005046: Provide checking for a default method in javax.lang.model
darcy
parents:
diff changeset
   145
}