Start cleanup of AnnotationTarget #507
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,84 @@ | ||
| package jakarta.enterprise.inject.build.compatible.spi; | ||
|
|
||
| import jakarta.enterprise.lang.model.AnnotationMember; | ||
| import jakarta.enterprise.lang.model.AnnotationMemberValue; | ||
| import jakarta.enterprise.lang.model.AnnotationInfo; | ||
| import jakarta.enterprise.lang.model.declarations.ClassInfo; | ||
| import java.lang.annotation.Annotation; | ||
| import java.util.List; | ||
|
|
||
| // TODO devise a builder-style API instead (see also AnnotationConfig) | ||
| public interface Annotations { | ||
| AnnotationMemberValue value(boolean value); | ||
|
|
||
| AnnotationMemberValue value(byte value); | ||
|
|
||
| AnnotationMemberValue value(short value); | ||
|
|
||
| AnnotationMemberValue value(int value); | ||
|
|
||
| AnnotationMemberValue value(long value); | ||
|
|
||
| AnnotationMemberValue value(float value); | ||
|
|
||
| AnnotationMemberValue value(double value); | ||
|
|
||
| AnnotationMemberValue value(char value); | ||
|
|
||
| AnnotationMemberValue value(String value); | ||
|
|
||
| AnnotationMemberValue value(Enum<?> enumValue); | ||
|
|
||
| AnnotationMemberValue value(Class<? extends Enum<?>> enumType, String enumValue); | ||
|
|
||
| AnnotationMemberValue value(ClassInfo<?> enumType, String enumValue); | ||
|
|
||
| AnnotationMemberValue value(Class<?> value); | ||
|
|
||
| AnnotationMemberValue annotationValue(Class<? extends Annotation> annotationType, AnnotationMember... attributes); | ||
|
|
||
| AnnotationMemberValue annotationValue(ClassInfo<?> annotationType, AnnotationMember... attributes); | ||
|
|
||
| AnnotationMemberValue annotationValue(AnnotationInfo annotation); | ||
|
|
||
| AnnotationMemberValue annotationValue(Annotation annotation); | ||
|
|
||
| AnnotationMember attribute(String name, boolean value); | ||
|
|
||
| AnnotationMember attribute(String name, byte value); | ||
|
|
||
| AnnotationMember attribute(String name, short value); | ||
|
|
||
| AnnotationMember attribute(String name, int value); | ||
|
|
||
| AnnotationMember attribute(String name, long value); | ||
|
|
||
| AnnotationMember attribute(String name, float value); | ||
|
|
||
| AnnotationMember attribute(String name, double value); | ||
|
|
||
| AnnotationMember attribute(String name, char value); | ||
|
|
||
| AnnotationMember attribute(String name, String value); | ||
|
|
||
| AnnotationMember attribute(String name, Enum<?> enumValue); | ||
|
|
||
| AnnotationMember attribute(String name, Class<? extends Enum<?>> enumType, String enumValue); | ||
|
|
||
| AnnotationMember attribute(String name, ClassInfo<?> enumType, String enumValue); | ||
|
|
||
| AnnotationMember attribute(String name, Class<?> value); | ||
|
|
||
| AnnotationMember arrayAttribute(String name, AnnotationMemberValue... values); | ||
|
|
||
| AnnotationMember arrayAttribute(String name, List<AnnotationMemberValue> values); | ||
|
|
||
| AnnotationMember annotationAttribute(String name, Class<? extends Annotation> annotationType, | ||
| AnnotationMember... attributes); | ||
|
|
||
| AnnotationMember annotationAttribute(String name, ClassInfo<?> annotationType, AnnotationMember... attributes); | ||
|
|
||
| AnnotationMember annotationAttribute(String name, AnnotationInfo annotation); | ||
|
|
||
| AnnotationMember annotationAttribute(String name, Annotation annotation); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,15 +1,29 @@ | ||||||
| package jakarta.enterprise.lang.model; | ||||||
|
|
||||||
| import jakarta.enterprise.lang.model.declarations.ClassInfo; | ||||||
|
|
||||||
| import java.lang.annotation.Annotation; | ||||||
| import java.lang.annotation.Repeatable; | ||||||
| import java.util.Collection; | ||||||
|
|
||||||
| /** | ||||||
| * Models an annotation definition, providing access to the {@link AnnotationMemberValue} | ||||||
| * instances. | ||||||
| * | ||||||
| * @param <T> The annotation type. | ||||||
| */ | ||||||
| public interface AnnotationInfo<T extends Annotation> { | ||||||
| /** | ||||||
| * The commonly used {@code value()} member. | ||||||
| */ | ||||||
| String MEMBER_VALUE = "value"; | ||||||
|
|
||||||
| /** | ||||||
| * Target of this annotation. | ||||||
| * That is, the declaration, the type parameter or the type use on which this annotation is present. | ||||||
| * TODO what if this annotation is a nested annotation? | ||||||
| * TODO what if this annotation doesn't have a known target (e.g. qualifier of a synthetic bean)? | ||||||
| * TODO Do we need this? Retrieving the target from an annotation value is not supported in Micronaut | ||||||
|
There was a problem hiding this comment. I think we can probably remove this. In Quarkus, the equivalent is used quite often, because we often start by simply looking up all annotations of some type, and then filter based on their target etc. But at the moment, I can't think of a way that would enable something like this in CDI Lite. I think we only allow top-down access, never bottom-up. There was a problem hiding this comment. Ok I will remove it in the PR |
||||||
| * | ||||||
| * @return target of this annotation | ||||||
| */ | ||||||
|
|
@@ -18,15 +32,15 @@ public interface AnnotationInfo { | |||||
| /** | ||||||
| * Declaration of this annotation's type. | ||||||
| * | ||||||
| * @return declaration of this annotation, never {@code null} | ||||||
| */ | ||||||
| ClassInfo<T> declaration(); | ||||||
|
|
||||||
| /** | ||||||
| * Fully qualified name of this annotation. | ||||||
| * Equivalent to {@code declaration().name()}. | ||||||
| * | ||||||
| * @return fully qualified name of this annotation, never {@code null} | ||||||
|
There was a problem hiding this comment. Off topic, since this was introduced earlier and you didn't change it, but I want to bring this up anyway. I recently learned that the JLS makes an important distinction between fully qualified name and binary name. They are identical for top-level types, but not for nested types. For example: package com.example;
public class MyClass {
public @interface MyAnnotation {
}
}Fully qualified name of the I think we should probably settle on binary names, and I started doing that here: https://github.com/eclipse-ee4j/cdi/pull/506/files#diff-a8c5a19048a48d991137c3ecb9f78f593b33a264b81a41bd5fa543cf9ac7ae73 WDYT about that? There was a problem hiding this comment. +1 for binary names |
||||||
| */ | ||||||
| default String name() { | ||||||
| return declaration().name(); | ||||||
|
|
@@ -43,34 +57,45 @@ default boolean isRepeatable() { | |||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Whether this annotation has a member with given {@code name}. | ||||||
| * | ||||||
| * @param name member name, never {@code null} | ||||||
| * @return whether this annotation has a member with given {@code name} | ||||||
| * @throws java.lang.IllegalArgumentException if the argument is {@code null} | ||||||
| */ | ||||||
| boolean hasMember(String name); | ||||||
|
|
||||||
| /** | ||||||
| * Value of this annotation's attribute with given {@code name}. | ||||||
| * | ||||||
| * @param name attribute name, never {@code null} | ||||||
| * @return value of this annotation's attribute with given {@code name} or {@code null} if it doesn't exist. | ||||||
| * @throws java.lang.IllegalArgumentException if the argument is {@code null} | ||||||
|
There was a problem hiding this comment. WDYT about the distintion between On the other hand, if the rest of CDI uses IAE, then I'd say we follow suit. There was a problem hiding this comment. Perhaps |
||||||
| */ | ||||||
| AnnotationMemberValue member(String name); | ||||||
|
|
||||||
| /** | ||||||
| * Returns whether this annotation has a value defined using the {@link #MEMBER_VALUE} member. | ||||||
|
There was a problem hiding this comment.
Suggested change
Reads better to me? |
||||||
| * | ||||||
| * @return Returns {@code true} if the {@link #MEMBER_VALUE} is set, {@code false} otherwise | ||||||
| */ | ||||||
| default boolean hasValue() { | ||||||
| return hasMember(MEMBER_VALUE); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Returns the {@link AnnotationMemberValue} instance that represents | ||||||
| * the value of the {@link #MEMBER_VALUE} member. | ||||||
| * @return An {@link AnnotationMemberValue} instance or {@code null} if none exists. | ||||||
| */ | ||||||
| default AnnotationMemberValue value() { | ||||||
| return member(MEMBER_VALUE); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * All members of this annotation. | ||||||
| * | ||||||
| * @return An immutable collection of all members of this annotation. Never {@code null}. | ||||||
| */ | ||||||
| Collection<AnnotationMember> members(); | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| package jakarta.enterprise.lang.model; | ||
|
|
||
| // TODO "attribute" is a colloquial expression, perhaps use something closer to the JLS? AnnotationMember? | ||
|
There was a problem hiding this comment. +1 to |
||
| public interface AnnotationMember { | ||
| String name(); | ||
|
|
||
| AnnotationMemberValue value(); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if this needs to be parameterized, but let's discuss that later.
(As for
ClassInfo, I'd pretty much love to remove the type parameter -- I originally added it to be able to express a query, but we don't allow "injecting"ClassInfoanymore and we wantClassConfigto not inherit fromClassInfo, so that reason no longer applies.)