|
| 1 | +/* |
| 2 | + * Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * The Universal Permissive License (UPL), Version 1.0 |
| 6 | + * |
| 7 | + * Subject to the condition set forth below, permission is hereby granted to any |
| 8 | + * person obtaining a copy of this software, associated documentation and/or |
| 9 | + * data (collectively the "Software"), free of charge and under any and all |
| 10 | + * copyright rights in the Software, and any and all patent rights owned or |
| 11 | + * freely licensable by each licensor hereunder covering either (i) the |
| 12 | + * unmodified Software as contributed to or provided by such licensor, or (ii) |
| 13 | + * the Larger Works (as defined below), to deal in both |
| 14 | + * |
| 15 | + * (a) the Software, and |
| 16 | + * |
| 17 | + * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if |
| 18 | + * one is included with the Software each a "Larger Work" to which the Software |
| 19 | + * is contributed by such licensors), |
| 20 | + * |
| 21 | + * without restriction, including without limitation the rights to copy, create |
| 22 | + * derivative works of, display, perform, and distribute the Software and make, |
| 23 | + * use, sell, offer for sale, import, export, have made, and have sold the |
| 24 | + * Software and the Larger Work(s), and to sublicense the foregoing rights on |
| 25 | + * either these or other terms. |
| 26 | + * |
| 27 | + * This license is subject to the following condition: |
| 28 | + * |
| 29 | + * The above copyright notice and either this complete permission notice or at a |
| 30 | + * minimum a reference to the UPL must be included in all copies or substantial |
| 31 | + * portions of the Software. |
| 32 | + * |
| 33 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 34 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 35 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 36 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 37 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 38 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 39 | + * SOFTWARE. |
| 40 | + */ |
| 41 | +package org.graalvm.nativeimage; |
| 42 | + |
| 43 | +import java.lang.annotation.Annotation; |
| 44 | +import java.lang.reflect.AnnotatedElement; |
| 45 | +import java.util.Arrays; |
| 46 | + |
| 47 | +import org.graalvm.nativeimage.impl.ImageBuildtimeCodeAnnotationAccessSupport; |
| 48 | + |
| 49 | +/** |
| 50 | + * This class provides methods to query annotation information on {@link AnnotatedElement}s while |
| 51 | + * trying to prevent, at image build time, side-effecting changes that impact the analysis results. |
| 52 | + * |
| 53 | + * The getAnnotation implementation in the JDK for Class, Field, and Method initializes the classes |
| 54 | + * of all annotations present on that element, not just the class of the queried annotation. This |
| 55 | + * leads to problems when not all annotation classes are present on the classpath/modulepath: |
| 56 | + * querying an annotation whose class is present can fail with an exception because not all |
| 57 | + * annotation classes are present. When this class's methods are called at image build time, then |
| 58 | + * the minimal amount of class initialization is done: {@link #getAnnotation} only initializes the |
| 59 | + * queried annotation class (when the annotation is actually present and therefore instantiated); |
| 60 | + * {@link #isAnnotationPresent} and {@link #getAnnotationTypes} do not initialize any classes. |
| 61 | + * |
| 62 | + * When methods of this class are called not at image build time, i.e., at image run time or during |
| 63 | + * the execution of a Java application not involving native image, then the JDK method to query the |
| 64 | + * annotation is invoked. In these cases, there is no difference to the class initialization |
| 65 | + * behavior of the JDK. |
| 66 | + * |
| 67 | + * Note that there is intentionally no `getAnnotations` method to query all annotations: all |
| 68 | + * annotation classes must be initialized anyways by this method, so the JDK method can be invoke |
| 69 | + * directly. In the image generator it should be generally avoided to use `getAnnotations`. |
| 70 | + * |
| 71 | + * @since 22.3 |
| 72 | + */ |
| 73 | +public final class AnnotationAccess { |
| 74 | + |
| 75 | + /** |
| 76 | + * Implementation of {@link AnnotatedElement#isAnnotationPresent(Class)}. |
| 77 | + * |
| 78 | + * @since 22.3 |
| 79 | + */ |
| 80 | + public static boolean isAnnotationPresent(AnnotatedElement element, Class<? extends Annotation> annotationClass) { |
| 81 | + if (ImageInfo.inImageBuildtimeCode()) { |
| 82 | + return ImageSingletons.lookup(ImageBuildtimeCodeAnnotationAccessSupport.class).isAnnotationPresent(element, annotationClass); |
| 83 | + } else { |
| 84 | + return element.isAnnotationPresent(annotationClass); |
| 85 | + } |
| 86 | + } |
| 87 | + |
| 88 | + /** |
| 89 | + * Implementation of {@link AnnotatedElement#getAnnotation(Class)} . |
| 90 | + * |
| 91 | + * @since 22.3 |
| 92 | + */ |
| 93 | + @SuppressWarnings("unchecked") |
| 94 | + public static <T extends Annotation> T getAnnotation(AnnotatedElement element, Class<T> annotationType) { |
| 95 | + if (ImageInfo.inImageBuildtimeCode()) { |
| 96 | + return (T) ImageSingletons.lookup(ImageBuildtimeCodeAnnotationAccessSupport.class).getAnnotation(element, annotationType); |
| 97 | + } else { |
| 98 | + return element.getAnnotation(annotationType); |
| 99 | + } |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * Implementation for retrieving all {@link Annotation#annotationType()}s for a {@code element}. |
| 104 | + * |
| 105 | + * @since 22.3 |
| 106 | + */ |
| 107 | + @SuppressWarnings("unchecked") |
| 108 | + public static Class<? extends Annotation>[] getAnnotationTypes(AnnotatedElement element) { |
| 109 | + if (ImageInfo.inImageBuildtimeCode()) { |
| 110 | + return ImageSingletons.lookup(ImageBuildtimeCodeAnnotationAccessSupport.class).getAnnotationTypes(element); |
| 111 | + } else { |
| 112 | + return Arrays.stream(element.getAnnotations()).map(Annotation::annotationType).toArray(Class[]::new); |
| 113 | + } |
| 114 | + } |
| 115 | + |
| 116 | + private AnnotationAccess() { |
| 117 | + } |
| 118 | +} |
0 commit comments