Skip to content

Commit 6af1d6f

Browse files
liachliach
committed
8335927: Revisit AnnotationConstantValueEntry and AnnotationValue.OfConstant
Reviewed-by: asotona
1 parent 9e282e5 commit 6af1d6f

File tree

12 files changed

+358
-181
lines changed

12 files changed

+358
-181
lines changed

‎src/java.base/share/classes/java/lang/classfile/AnnotationValue.java

Lines changed: 265 additions & 82 deletions
Large diffs are not rendered by default.

‎src/java.base/share/classes/java/lang/classfile/constantpool/AnnotationConstantValueEntry.java

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -24,13 +24,23 @@
2424
*/
2525
package java.lang.classfile.constantpool;
2626

27+
import java.lang.classfile.AnnotationValue;
2728
import java.lang.constant.ConstantDesc;
2829
import jdk.internal.javac.PreviewFeature;
2930

3031
/**
31-
* A constant pool entry that may be used as an annotation constant,
32-
* which includes the four kinds of primitive constants, and UTF8 constants.
32+
* A constant pool entry that may be used by annotation constant values,
33+
* which includes the four kinds of primitive constants and UTF8 constants.
34+
* These entries are also the only entries that do not refer to other
35+
* constant pool entries.
3336
*
37+
* @apiNote
38+
* An annotation constant value entry alone is not sufficient to determine
39+
* the annotation constant; for example, an {@link IntegerEntry} of {@code 1}
40+
* can mean {@code true} in {@link AnnotationValue.OfBoolean} or {@code 1}
41+
* in {@link AnnotationValue.OfInt}.
42+
*
43+
* @see AnnotationValue.OfConstant
3444
* @sealedGraph
3545
* @since 22
3646
*/
@@ -40,7 +50,8 @@ public sealed interface AnnotationConstantValueEntry extends PoolEntry
4050

4151
/**
4252
* {@return the constant value} The constant value will be an {@link Integer},
43-
* {@link Long}, {@link Float}, {@link Double}, or {@link String}.
53+
* {@link Long}, {@link Float}, {@link Double} for the primitive constants,
54+
* or {@link String} for UTF8 constants.
4455
*/
4556
ConstantDesc constantValue();
4657
}

‎src/java.base/share/classes/java/lang/classfile/constantpool/ConstantPoolBuilder.java

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -510,25 +510,6 @@ default LoadableConstantEntry loadableConstantEntry(ConstantDesc c) {
510510
throw new IllegalArgumentException("Illegal type: " + (c == null ? null : c.getClass()));
511511
}
512512

513-
/**
514-
* {@return An {@link AnnotationConstantValueEntry} describing the provided
515-
* constant} The constant should be an Integer, String, Long, Float,
516-
* Double, ClassDesc (for a Class constant), or MethodTypeDesc (for a MethodType
517-
* constant.)
518-
*
519-
* @param c the constant
520-
*/
521-
default AnnotationConstantValueEntry annotationConstantValueEntry(ConstantDesc c) {
522-
if (c instanceof Integer i) return intEntry(i);
523-
if (c instanceof String s) return utf8Entry(s);
524-
if (c instanceof Long l) return longEntry(l);
525-
if (c instanceof Float f) return floatEntry(f);
526-
if (c instanceof Double d) return doubleEntry(d);
527-
if (c instanceof ClassDesc cd) return utf8Entry(cd);
528-
if (c instanceof MethodTypeDesc mtd) return utf8Entry(mtd);
529-
throw new IllegalArgumentException("Illegal type: " + (c == null ? null : c.getClass()));
530-
}
531-
532513
/**
533514
* {@return a {@link BootstrapMethodEntry} describing the provided
534515
* bootstrap method and static arguments}

‎src/java.base/share/classes/jdk/internal/classfile/impl/AnnotationImpl.java

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
import java.lang.classfile.*;
2828
import java.lang.classfile.constantpool.*;
2929

30-
import java.lang.constant.ConstantDesc;
3130
import java.util.List;
3231

3332
import static java.lang.classfile.ClassFile.*;
@@ -80,28 +79,18 @@ public void writeTo(BufWriterImpl buf) {
8079
}
8180
}
8281

83-
public sealed interface OfConstantImpl extends AnnotationValue.OfConstant, Util.Writable
84-
permits AnnotationImpl.OfStringImpl, AnnotationImpl.OfDoubleImpl,
85-
AnnotationImpl.OfFloatImpl, AnnotationImpl.OfLongImpl,
86-
AnnotationImpl.OfIntegerImpl, AnnotationImpl.OfShortImpl,
87-
AnnotationImpl.OfCharacterImpl, AnnotationImpl.OfByteImpl,
88-
AnnotationImpl.OfBooleanImpl {
82+
public sealed interface OfConstantImpl extends AnnotationValue.OfConstant, Util.Writable {
8983

9084
@Override
9185
default void writeTo(BufWriterImpl buf) {
9286
buf.writeU1(tag());
9387
buf.writeIndex(constant());
9488
}
9589

96-
@Override
97-
default ConstantDesc constantValue() {
98-
return constant().constantValue();
99-
}
100-
10190
}
10291

10392
public record OfStringImpl(Utf8Entry constant)
104-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfString {
93+
implements OfConstantImpl, AnnotationValue.OfString {
10594

10695
@Override
10796
public char tag() {
@@ -115,7 +104,7 @@ public String stringValue() {
115104
}
116105

117106
public record OfDoubleImpl(DoubleEntry constant)
118-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfDouble {
107+
implements OfConstantImpl, AnnotationValue.OfDouble {
119108

120109
@Override
121110
public char tag() {
@@ -129,7 +118,7 @@ public double doubleValue() {
129118
}
130119

131120
public record OfFloatImpl(FloatEntry constant)
132-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfFloat {
121+
implements OfConstantImpl, AnnotationValue.OfFloat {
133122

134123
@Override
135124
public char tag() {
@@ -143,7 +132,7 @@ public float floatValue() {
143132
}
144133

145134
public record OfLongImpl(LongEntry constant)
146-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfLong {
135+
implements OfConstantImpl, AnnotationValue.OfLong {
147136

148137
@Override
149138
public char tag() {
@@ -156,8 +145,8 @@ public long longValue() {
156145
}
157146
}
158147

159-
public record OfIntegerImpl(IntegerEntry constant)
160-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfInteger {
148+
public record OfIntImpl(IntegerEntry constant)
149+
implements OfConstantImpl, AnnotationValue.OfInt {
161150

162151
@Override
163152
public char tag() {
@@ -171,7 +160,7 @@ public int intValue() {
171160
}
172161

173162
public record OfShortImpl(IntegerEntry constant)
174-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfShort {
163+
implements OfConstantImpl, AnnotationValue.OfShort {
175164

176165
@Override
177166
public char tag() {
@@ -180,12 +169,12 @@ public char tag() {
180169

181170
@Override
182171
public short shortValue() {
183-
return (short)constant().intValue();
172+
return (short) constant().intValue();
184173
}
185174
}
186175

187-
public record OfCharacterImpl(IntegerEntry constant)
188-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfCharacter {
176+
public record OfCharImpl(IntegerEntry constant)
177+
implements OfConstantImpl, AnnotationValue.OfChar {
189178

190179
@Override
191180
public char tag() {
@@ -194,12 +183,12 @@ public char tag() {
194183

195184
@Override
196185
public char charValue() {
197-
return (char)constant().intValue();
186+
return (char) constant().intValue();
198187
}
199188
}
200189

201190
public record OfByteImpl(IntegerEntry constant)
202-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfByte {
191+
implements OfConstantImpl, AnnotationValue.OfByte {
203192

204193
@Override
205194
public char tag() {
@@ -208,12 +197,12 @@ public char tag() {
208197

209198
@Override
210199
public byte byteValue() {
211-
return (byte)constant().intValue();
200+
return (byte) constant().intValue();
212201
}
213202
}
214203

215204
public record OfBooleanImpl(IntegerEntry constant)
216-
implements AnnotationImpl.OfConstantImpl, AnnotationValue.OfBoolean {
205+
implements OfConstantImpl, AnnotationValue.OfBoolean {
217206

218207
@Override
219208
public char tag() {
@@ -222,15 +211,15 @@ public char tag() {
222211

223212
@Override
224213
public boolean booleanValue() {
225-
return constant().intValue() == 1;
214+
return constant().intValue() != 0;
226215
}
227216
}
228217

229218
public record OfArrayImpl(List<AnnotationValue> values)
230219
implements AnnotationValue.OfArray, Util.Writable {
231220

232-
public OfArrayImpl(List<AnnotationValue> values) {
233-
this.values = List.copyOf(values);
221+
public OfArrayImpl {
222+
values = List.copyOf(values);
234223
}
235224

236225
@Override

‎src/java.base/share/classes/jdk/internal/classfile/impl/AnnotationReader.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ public static AnnotationValue readElementValue(ClassReader classReader, int p) {
6060
++p;
6161
return switch (tag) {
6262
case AEV_BYTE -> new AnnotationImpl.OfByteImpl(classReader.readEntry(p, IntegerEntry.class));
63-
case AEV_CHAR -> new AnnotationImpl.OfCharacterImpl(classReader.readEntry(p, IntegerEntry.class));
63+
case AEV_CHAR -> new AnnotationImpl.OfCharImpl(classReader.readEntry(p, IntegerEntry.class));
6464
case AEV_DOUBLE -> new AnnotationImpl.OfDoubleImpl(classReader.readEntry(p, DoubleEntry.class));
6565
case AEV_FLOAT -> new AnnotationImpl.OfFloatImpl(classReader.readEntry(p, FloatEntry.class));
66-
case AEV_INT -> new AnnotationImpl.OfIntegerImpl(classReader.readEntry(p, IntegerEntry.class));
66+
case AEV_INT -> new AnnotationImpl.OfIntImpl(classReader.readEntry(p, IntegerEntry.class));
6767
case AEV_LONG -> new AnnotationImpl.OfLongImpl(classReader.readEntry(p, LongEntry.class));
6868
case AEV_SHORT -> new AnnotationImpl.OfShortImpl(classReader.readEntry(p, IntegerEntry.class));
6969
case AEV_BOOLEAN -> new AnnotationImpl.OfBooleanImpl(classReader.readEntry(p, IntegerEntry.class));

‎src/java.base/share/classes/jdk/internal/classfile/impl/ClassPrinterImpl.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -507,15 +507,15 @@ private static String toXmlName(String name) {
507507

508508
private static Node[] elementValueToTree(AnnotationValue v) {
509509
return switch (v) {
510-
case OfString cv -> leafs("string", String.valueOf(cv.constantValue()));
511-
case OfDouble cv -> leafs("double", String.valueOf(cv.constantValue()));
512-
case OfFloat cv -> leafs("float", String.valueOf(cv.constantValue()));
513-
case OfLong cv -> leafs("long", String.valueOf(cv.constantValue()));
514-
case OfInteger cv -> leafs("int", String.valueOf(cv.constantValue()));
515-
case OfShort cv -> leafs("short", String.valueOf(cv.constantValue()));
516-
case OfCharacter cv -> leafs("char", String.valueOf(cv.constantValue()));
517-
case OfByte cv -> leafs("byte", String.valueOf(cv.constantValue()));
518-
case OfBoolean cv -> leafs("boolean", String.valueOf((int)cv.constantValue() != 0));
510+
case OfString cv -> leafs("string", String.valueOf(cv.stringValue()));
511+
case OfDouble cv -> leafs("double", String.valueOf(cv.doubleValue()));
512+
case OfFloat cv -> leafs("float", String.valueOf(cv.floatValue()));
513+
case OfLong cv -> leafs("long", String.valueOf(cv.longValue()));
514+
case OfInt cv -> leafs("int", String.valueOf(cv.intValue()));
515+
case OfShort cv -> leafs("short", String.valueOf(cv.shortValue()));
516+
case OfChar cv -> leafs("char", String.valueOf(cv.charValue()));
517+
case OfByte cv -> leafs("byte", String.valueOf(cv.byteValue()));
518+
case OfBoolean cv -> leafs("boolean", String.valueOf(cv.booleanValue()));
519519
case OfClass clv -> leafs("class", clv.className().stringValue());
520520
case OfEnum ev -> leafs("enum class", ev.className().stringValue(),
521521
"constant name", ev.constantName().stringValue());

‎test/jdk/jdk/classfile/AnnotationTest.java

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
*/
2929
import java.lang.constant.ClassDesc;
3030
import static java.lang.constant.ConstantDescs.*;
31+
32+
import java.lang.constant.ConstantDesc;
3133
import java.lang.constant.MethodTypeDesc;
3234
import java.util.AbstractMap;
3335
import java.util.ArrayList;
@@ -39,6 +41,8 @@
3941
import java.lang.classfile.attribute.RuntimeVisibleAnnotationsAttribute;
4042
import java.lang.classfile.*;
4143
import java.lang.classfile.constantpool.ConstantPoolBuilder;
44+
import java.util.stream.Stream;
45+
4246
import org.junit.jupiter.api.Test;
4347

4448
import static java.util.stream.Collectors.toList;
@@ -53,26 +57,30 @@
5357
class AnnotationTest {
5458
enum E {C};
5559

56-
private static Map<String, Object> constants
60+
// name -> (value, poolValue)
61+
private static final Map<String, Map.Entry<Object, ConstantDesc>> constants
5762
= Map.ofEntries(
58-
new AbstractMap.SimpleImmutableEntry<>("i", 1),
59-
new AbstractMap.SimpleImmutableEntry<>("j", 1L),
60-
new AbstractMap.SimpleImmutableEntry<>("s", 1),
61-
new AbstractMap.SimpleImmutableEntry<>("b", 1),
62-
new AbstractMap.SimpleImmutableEntry<>("f", 1.0f),
63-
new AbstractMap.SimpleImmutableEntry<>("d", 1.0d),
64-
new AbstractMap.SimpleImmutableEntry<>("z", 1),
65-
new AbstractMap.SimpleImmutableEntry<>("c", (int) '1'),
66-
new AbstractMap.SimpleImmutableEntry<>("st", "1"),
67-
new AbstractMap.SimpleImmutableEntry<>("cl", ClassDesc.of("foo.Bar")),
68-
new AbstractMap.SimpleImmutableEntry<>("en", E.C),
69-
new AbstractMap.SimpleImmutableEntry<>("arr", new Object[] {1, "1", 1.0f})
63+
Map.entry("i", Map.entry(1, 1)),
64+
Map.entry("j", Map.entry(1L, 1L)),
65+
Map.entry("s", Map.entry((short) 1, 1)),
66+
Map.entry("b", Map.entry((byte) 1, 1)),
67+
Map.entry("f", Map.entry(1.0f, 1.0f)),
68+
Map.entry("d", Map.entry(1.0d, 1.0d)),
69+
Map.entry("z", Map.entry(true, 1)),
70+
Map.entry("c", Map.entry('1', (int) '1')),
71+
Map.entry("st", Map.entry("1", "1"))
7072
);
7173

72-
private static final List<AnnotationElement> constantElements =
74+
private static final List<AnnotationElement> constantElements = Stream.concat(
7375
constants.entrySet().stream()
74-
.map(e -> AnnotationElement.of(e.getKey(), AnnotationValue.of(e.getValue())))
75-
.toList();
76+
.map(e -> Map.entry(e.getKey(), e.getValue().getKey())),
77+
Stream.of(
78+
Map.entry("cl", ClassDesc.of("foo.Bar")),
79+
Map.entry("en", E.C),
80+
Map.entry("arr", new Object[] {1, "1", 1.0f})
81+
))
82+
.map(e -> AnnotationElement.of(e.getKey(), AnnotationValue.of(e.getValue())))
83+
.toList();
7684

7785
private static List<AnnotationElement> elements() {
7886
List<AnnotationElement> list = new ArrayList<>(constantElements);
@@ -88,9 +96,12 @@ private static boolean assertAnno(Annotation a, String annoClassDescriptor, bool
8896
names.add(evp.name().stringValue());
8997
switch (evp.name().stringValue()) {
9098
case "i", "j", "s", "b", "f", "d", "z", "c", "st":
91-
assertTrue (evp.value() instanceof AnnotationValue.OfConstant c);
92-
assertEquals(((AnnotationValue.OfConstant) evp.value()).constantValue(),
93-
constants.get(evp.name().stringValue()));
99+
if (!(evp.value() instanceof AnnotationValue.OfConstant c))
100+
return fail();
101+
assertEquals(c.resolvedValue(),
102+
constants.get(evp.name().stringValue()).getKey());
103+
assertEquals(c.constant().constantValue(),
104+
constants.get(evp.name().stringValue()).getValue());
94105
break;
95106
case "cl":
96107
assertTrue (evp.value() instanceof AnnotationValue.OfClass c
@@ -105,8 +116,9 @@ private static boolean assertAnno(Annotation a, String annoClassDescriptor, bool
105116
&& assertAnno(c.annotation(), "LBar;", false));
106117
break;
107118
case "arr":
108-
assertTrue (evp.value() instanceof AnnotationValue.OfArray);
109-
List<AnnotationValue> values = ((AnnotationValue.OfArray) evp.value()).values();
119+
if (!(evp.value() instanceof AnnotationValue.OfArray arr))
120+
return fail();
121+
List<AnnotationValue> values = arr.values();
110122
assertEquals(values.stream().map(v -> ((AnnotationValue.OfConstant) v).constant().constantValue()).collect(toSet()),
111123
Set.of(1, 1.0f, "1"));
112124
break;

0 commit comments

Comments
 (0)