--- old/src/share/classes/java/lang/reflect/AnnotatedElement.java 2013-10-27 14:37:22.000000000 -0700 +++ new/src/share/classes/java/lang/reflect/AnnotatedElement.java 2013-10-27 14:37:22.000000000 -0700 @@ -27,6 +27,10 @@ import java.lang.annotation.Annotation; import java.lang.annotation.AnnotationFormatError; +import java.lang.annotation.Repeatable; +import java.util.Objects; +import sun.reflect.annotation.AnnotationSupport; +import sun.reflect.annotation.AnnotationType; /** * Represents an annotated element of the program currently running in this @@ -222,6 +226,16 @@ * The caller of this method is free to modify the returned array; it will * have no effect on the arrays returned to other callers. * + * @implSpec The default implementation first calls {@link + * #getDeclaredAnnotationsByType(Class)} on the argument type. If + * the returned array has size greater than zero, the array is + * returned. If the returned array has size zero and this {@code + * AnnotatedElement} is a class and the argument type is an + * inheritable annotation, and the superclass of this {@code + * AnnoatedElement} is non-null, then the result of {@code + * getAnnotationsByType(annotationClass)} on the superclass is + * returned. Otherwise, a zero-length array is returned. + * * @param the type of the annotation to query for and return if present * @param annotationClass the Class object corresponding to the * annotation type @@ -230,8 +244,30 @@ * @throws NullPointerException if the given annotation class is null * @since 1.8 */ - T[] getAnnotationsByType(Class annotationClass); + default T[] getAnnotationsByType(Class annotationClass) { + /* + * Definition of associated: directly or indirectly present OR + * neither directly nor indirectly present AND the element is + * a Class, the annotation type is inheritable, and the + * annotation type is associated with the superclass of the + * element. + */ + T[] result = getDeclaredAnnotationsByType(annotationClass); + + if (result.length == 0 && // Neither directly nor indirectly present + this instanceof Class && // the element is a class + AnnotationType.getInstance(annotationClass).isInherited()) { // Inheritable + Class superClass = ((Class) this).getSuperclass(); + if (superClass != null) { + // Determine if the annotation is associated with the + // superclass + result = superClass.getAnnotationsByType(annotationClass); + } + } + return result; + } + /** * Returns this element's annotation for the specified type if * such an annotation is directly present, else null. @@ -239,6 +275,11 @@ * This method ignores inherited annotations. (Returns null if no * annotations are directly present on this element.) * + * @implSpec The default implementation first performs a null check + * and then loops over the results of {@link + * getDeclaredAnnotations} returning the first annotation whose + * annotation type matches the argument type. + * * @param the type of the annotation to query for and return if directly present * @param annotationClass the Class object corresponding to the * annotation type @@ -247,7 +288,18 @@ * @throws NullPointerException if the given annotation class is null * @since 1.8 */ - T getDeclaredAnnotation(Class annotationClass); + default T getDeclaredAnnotation(Class annotationClass) { + Objects.requireNonNull(annotationClass); + // Loop over all directly-present annotations looking for a matching one + for (Annotation annotation : getDeclaredAnnotations()) { + if (annotationClass.equals(annotation.annotationType())) { + // More robust to do a dynamic cast at runtime instead + // of compile-time only. + return annotationClass.cast(annotation); + } + } + return null; + } /** * Returns this element's annotation(s) for the specified type if @@ -268,6 +320,19 @@ * The caller of this method is free to modify the returned array; it will * have no effect on the arrays returned to other callers. * + * @implSpec The default implementation may call {@link + * #getDeclaredAnnotation(Class)} one or more times to find a + * directly present annotation and, if the annotation type is + * repeatable, to find a container annotation. If the annotation + * type is both directly and indirectly present, {@link + * getDeclaredAnnotations()} will get called to determine the + * order of the elements in the returned array. Alternatively, + * {@link getDeclaredAnnotations()} may be called a single time + * and the returned array examined for both directly and + * indirectly present annotations. The results of calling {@link + * getDeclaredAnnotations()} are assumed to be consistent with the + * results of calling {@code #getDeclaredAnnotation} + * * @param the type of the annotation to query for and return * if directly or indirectly present * @param annotationClass the Class object corresponding to the @@ -277,7 +342,97 @@ * @throws NullPointerException if the given annotation class is null * @since 1.8 */ - T[] getDeclaredAnnotationsByType(Class annotationClass); + default T[] getDeclaredAnnotationsByType(Class annotationClass) + { + Objects.requireNonNull(annotationClass); + int resultSize = 0; + T directlyPresent = getDeclaredAnnotation(annotationClass); + + if (directlyPresent != null) { + resultSize++; + } + + Repeatable repeatable = annotationClass.getAnnotation(Repeatable.class); + if (repeatable == null) { + @SuppressWarnings("unchecked") + T[] returnValue = (T[]) Array.newInstance(annotationClass, resultSize); + if (directlyPresent != null) + returnValue[0] = directlyPresent; + return returnValue; + } else { + // directlyPresent may or may not be null + + // Look through a container to see if an annotation is + // indirectly present + Class containerType = repeatable.value(); + Annotation container = getDeclaredAnnotation(containerType); + T[] indirectlyPresent = null; + + if (container != null) { + indirectlyPresent = AnnotationSupport.getValueArray(container); + resultSize += indirectlyPresent.length; + } + + // Final result size is known + + // todo: review comment for accuracy... + /* + * If resultSize is 0, indirectlyPresent is either + * assigned to the result of the initial Array.newInstance + * call or indirectlyPresent is assigned to a zero-length + * value array from an empty container annotation. In + * either case, a zero-length array is immutable and does + * not need to reallocated before being returned. + * + * If resultSize is nonzero, then indirectlyPresent points + * to the result calling a method on an annotation and + * annotations are required to implement a no sharing + * policy. Therefore, it is not required to copy the + * elements of indirectlyPresent into a new array of the + * same size. + */ + if (indirectlyPresent == null || indirectlyPresent.length == 0) { + @SuppressWarnings("unchecked") + T[] returnValue = (T[]) Array.newInstance(annotationClass, resultSize); + if (resultSize == 1) + returnValue[0] = directlyPresent; + return returnValue; + } else { + // assert indirectlyPresent != null && indirectlyPresent.length > 0; + + if (resultSize == indirectlyPresent.length){ + // assert resultSize == 0 || directlyPresent == null; + return indirectlyPresent; + } else { + // assert directlyPresent != null && indirectlyPresent.length > 0; + @SuppressWarnings("unchecked") + T[] returnValue = (T[]) Array.newInstance(annotationClass, resultSize); + + // Determine whether the directly present annotation + // comes before or after the indirectly present ones. + + int indirectOffset = 0; + + for (Annotation a : getDeclaredAnnotations()) { + if (a.annotationType().equals(annotationClass)) { + indirectOffset = 1; + break; + } else if (a.annotationType().equals(containerType)) { + break; + } + } + + for (int i = 0; i < indirectlyPresent.length; i++) { + returnValue[i + indirectOffset] = indirectlyPresent[i]; + } + + returnValue[(indirectOffset == 1) ? 0 : resultSize - 1] = directlyPresent; + return returnValue; + } + } + } + } + /** * Returns annotations that are directly present on this element. --- old/src/share/classes/sun/reflect/annotation/AnnotationSupport.java 2013-10-27 14:37:23.000000000 -0700 +++ new/src/share/classes/sun/reflect/annotation/AnnotationSupport.java 2013-10-27 14:37:23.000000000 -0700 @@ -175,10 +175,12 @@ } - /* Reflectively invoke the values-method of the given annotation - * (container), cast it to an array of annotations and return the result. + /* + * Reflectively invoke the values-method of the given annotation + * (container), cast it to an array of annotations and return the + * result. */ - private static A[] getValueArray(Annotation container) { + public static A[] getValueArray(Annotation container) { try { // According to JLS the container must have an array-valued value // method. Get the AnnotationType, get the "value" method and invoke @@ -199,16 +201,12 @@ // return-value in the method that call this method. @SuppressWarnings("unchecked") A[] values = (A[]) m.invoke(container); - return values; - } catch (IllegalAccessException | // couldn't loosen security IllegalArgumentException | // parameters doesn't match InvocationTargetException | // the value method threw an exception ClassCastException e) { - throw invalidContainerException(container, e); - } } --- /dev/null 2013-10-26 23:41:01.970822499 -0700 +++ new/test/java/lang/reflect/AnnotatedElement/TestAnnotatedElementDefaults.java 2013-10-27 14:37:23.000000000 -0700 @@ -0,0 +1,287 @@ +/* + * Copyright (c) 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 8005294 + * @summary Check behavior of default methods of AnnotatedElement + * @author Joseph D. Darcy + */ + +import java.lang.annotation.*; +import java.lang.reflect.*; +import java.util.*; + +public class TestAnnotatedElementDefaults { + public static void main(String... args) throws SecurityException { + int failures = 0; + + List annotatedElements = new ArrayList<>(); + annotatedElements.add(TestClass1Super.class); + annotatedElements.add(TestClass1.class); + for (Method method : TestClass1.class.getDeclaredMethods()) { + annotatedElements.add(method); + } + + List> annotations = new ArrayList<>(); + annotations.add(Missing.class); + annotations.add(MissingRepeatable.class); + annotations.add(DirectlyPresent.class); + annotations.add(IndirectlyPresent.class); + annotations.add(IndirectlyPresentContainer.class); + annotations.add(DirectlyAndIndirectlyPresent.class); + annotations.add(DirectlyAndIndirectlyPresentContainer.class); + + for (AnnotatedElement annotElement : annotatedElements) { + System.out.println(annotElement); + AnnotatedElementDelegate delegate = new AnnotatedElementDelegate(annotElement); + failures += testNullHandling(delegate); + for (Class annotType : annotations) { + failures += AnnotatedElementDelegate.testDelegate(delegate, annotType); + } + } + + if (failures > 0) + throw new RuntimeException(); + } + + private static int testNullHandling(AnnotatedElementDelegate delegate) { + int failures = 0; + try { + Object result = delegate.getDeclaredAnnotationsByType(null); + failures++; + } catch (NullPointerException npe) { + ; // Expected + } + + try { + Object result = delegate.getAnnotationsByType(null); + failures++; + } catch (NullPointerException npe) { + ; // Expected + } + + try { + Object result = delegate.getDeclaredAnnotation(null); + failures++; + } catch (NullPointerException npe) { + ; // Expected + } + + return failures; + } + +} + +// ----------------------------------------------------- + +/* + * For annotation types including {null, PresentAnnotation, + * MissingAnnotation, RepeatableAnnotation, ...} the behavior of + * AnnotedElementDelegate.foo(arg) is compared for equality to + * baseAnnotatedElement.foo(arg). + + * Consider annotation types + + * @NonRepeatable + * @NonRepeatableInheritable + +* Base annotated elements will include a Class object (where +* annotation inheritance can some input play) and a non-Class object. + +*/ + +@AssociatedDirectOnSuperClass(123) +@AssociatedIndirectOnSuperClass(234) @AssociatedIndirectOnSuperClass(345) +class TestClass1Super {} + +@DirectlyPresent(1) +@IndirectlyPresent(10) @IndirectlyPresent(11) +class TestClass1 extends TestClass1Super { + + @DirectlyPresent(2) + @IndirectlyPresentContainer({@IndirectlyPresent(12)}) + @DirectlyAndIndirectlyPresentContainer({@DirectlyAndIndirectlyPresent(84), @DirectlyAndIndirectlyPresent(96)}) + public void foo() {return ;} + + @IndirectlyPresentContainer({}) + @DirectlyAndIndirectlyPresentContainer({@DirectlyAndIndirectlyPresent(11), @DirectlyAndIndirectlyPresent(22)}) + @DirectlyAndIndirectlyPresent(33) + public void bar() {return ;} +} + +// ----------------------------------------------------- + +@Retention(RetentionPolicy.RUNTIME) +@interface DirectlyPresent { + int value(); +} + +// ----------------------------------------------------- + +@Retention(RetentionPolicy.RUNTIME) +@Repeatable(IndirectlyPresentContainer.class) +@interface IndirectlyPresent { + int value(); +} + +@Retention(RetentionPolicy.RUNTIME) +@interface IndirectlyPresentContainer { + IndirectlyPresent[] value(); +} + +// ----------------------------------------------------- + +@Retention(RetentionPolicy.RUNTIME) +@Repeatable(DirectlyAndIndirectlyPresentContainer.class) +@interface DirectlyAndIndirectlyPresent { + int value(); + +} + +@Retention(RetentionPolicy.RUNTIME) +@interface DirectlyAndIndirectlyPresentContainer { + DirectlyAndIndirectlyPresent[] value(); +} + +// ----------------------------------------------------- + +@Retention(RetentionPolicy.RUNTIME) +@interface Missing { + int value(); +} + +// ----------------------------------------------------- + +@Retention(RetentionPolicy.RUNTIME) +@Repeatable(MissingRepeatableContainer.class) +@interface MissingRepeatable { + int value(); +} + +@Retention(RetentionPolicy.RUNTIME) +@interface MissingRepeatableContainer { + MissingRepeatable[] value(); +} + +// ----------------------------------------------------- + +@Retention(RetentionPolicy.RUNTIME) +@Repeatable(AssociatedDirectOnSuperClassContainer.class) +@interface AssociatedDirectOnSuperClass { + int value(); +} + +@Retention(RetentionPolicy.RUNTIME) +@interface AssociatedDirectOnSuperClassContainer { + AssociatedDirectOnSuperClass[] value(); +} + +// ----------------------------------------------------- + +@Retention(RetentionPolicy.RUNTIME) +@Repeatable(AssociatedIndirectOnSuperClassContainer.class) +@interface AssociatedIndirectOnSuperClass { + int value(); +} + +@Retention(RetentionPolicy.RUNTIME) +@interface AssociatedIndirectOnSuperClassContainer { + AssociatedIndirectOnSuperClass[] value(); +} + +// ----------------------------------------------------- + +/** + * Helper class to ease calling the default methods of {@code + * AnnotatedElement} and comparing the results to other + * implementation. + */ +class AnnotatedElementDelegate implements AnnotatedElement { + private AnnotatedElement base; + + public AnnotatedElementDelegate(AnnotatedElement base) { + Objects.requireNonNull(base); + this.base = base; + } + +// // FIXME -- adjust once build / vm problems resolved +// @Override +// public T[] getDeclaredAnnotationsByType(Class annotationClass) { +// return base.getDeclaredAnnotationsByType(annotationClass); +// } + + // Delegate to base implemenetation of AnnotatedElement methods + // without defaults. + @Override + public T getAnnotation(Class annotationClass) { + return base.getAnnotation(annotationClass); + } + + @Override + public Annotation[] getAnnotations() { + return base.getAnnotations(); + } + + @Override + public Annotation[] getDeclaredAnnotations() { + return base.getDeclaredAnnotations(); + } + + public AnnotatedElement getBase() { + return base; + } + + static int testDelegate(AnnotatedElementDelegate delegate, + Class annotationClass) { + int failures = 0; + AnnotatedElement base = delegate.getBase(); + + // System.out.println("\tTesting " + delegate + "\ton\t" + annotationClass); + + // T[] getDeclaredAnnotationsByType(Class annotationClass) + if (!Objects.deepEquals(delegate.getDeclaredAnnotationsByType(annotationClass), + base.getDeclaredAnnotationsByType(annotationClass))) { + failures++; + System.err.printf("Equality failure on getDeclaredAnnotationsByType(%s) on %s)%n", + annotationClass, delegate); + } + + // T[] getAnnotationsByType(Class annotationClass) + if (!Objects.deepEquals(delegate.getAnnotationsByType(annotationClass), + base.getAnnotationsByType(annotationClass))) { + failures++; + System.err.printf("Equality failure on getAnnotationsByType(%s) on %s)%n", + annotationClass, delegate); + } + + // T getDeclaredAnnotation(Class annotationClass) + if (!Objects.equals(delegate.getDeclaredAnnotation(annotationClass), + base.getDeclaredAnnotation(annotationClass))) { + failures++; + System.err.printf("Equality failure on getDeclaredAnnotation(%s) on %s)%n", + annotationClass, delegate); + } + return failures; + } +}