Skip to content

Commit 6fd1442

Browse files
jddarcyjddarcy
committedNov 18, 2022
8296743: Tighten Class.getModifiers spec for array classes
Reviewed-by: rriggs, mchung, heidinga
1 parent 3a15e84 commit 6fd1442

File tree

3 files changed

+171
-37
lines changed

3 files changed

+171
-37
lines changed
 

‎src/java.base/share/classes/java/lang/Class.java

+29-22
Original file line numberDiff line numberDiff line change
@@ -1296,17 +1296,21 @@ private Class<?> elementType() {
12961296
* {@code abstract} and {@code interface}; they should be decoded
12971297
* using the methods of class {@code Modifier}.
12981298
*
1299-
* <p> If the underlying class is an array class, then its
1300-
* {@code public}, {@code private} and {@code protected}
1301-
* modifiers are the same as those of its component type. If this
1302-
* {@code Class} object represents a primitive type or void, its
1303-
* {@code public} modifier is always {@code true}, and its
1304-
* {@code protected} and {@code private} modifiers are always
1305-
* {@code false}. If this {@code Class} object represents an array class, a
1306-
* primitive type or void, then its {@code final} modifier is always
1307-
* {@code true} and its interface modifier is always
1308-
* {@code false}. The values of its other modifiers are not determined
1309-
* by this specification.
1299+
* <p> If the underlying class is an array class:
1300+
* <ul>
1301+
* <li> its {@code public}, {@code private} and {@code protected}
1302+
* modifiers are the same as those of its component type
1303+
* <li> its {@code abstract} and {@code final} modifiers are always
1304+
* {@code true}
1305+
* <li> its interface modifier is always {@code false}, even when
1306+
* the component type is an interface
1307+
* </ul>
1308+
* If this {@code Class} object represents a primitive type or
1309+
* void, its {@code public}, {@code abstract}, and {@code final}
1310+
* modifiers are always {@code true}.
1311+
* For {@code Class} objects representing void, primitive types, and
1312+
* arrays, the values of other modifiers are {@code false} other
1313+
* than as specified above.
13101314
*
13111315
* <p> The modifier encodings are defined in section {@jvms 4.1}
13121316
* of <cite>The Java Virtual Machine Specification</cite>.
@@ -1320,6 +1324,7 @@ private Class<?> elementType() {
13201324
* @since 1.1
13211325
* @jls 8.1.1 Class Modifiers
13221326
* @jls 9.1.1. Interface Modifiers
1327+
* @jvms 4.1 The {@code ClassFile} Structure
13231328
*/
13241329
@IntrinsicCandidate
13251330
public native int getModifiers();
@@ -1328,17 +1333,19 @@ private Class<?> elementType() {
13281333
* {@return an unmodifiable set of the {@linkplain AccessFlag access
13291334
* flags} for this class, possibly empty}
13301335
*
1331-
* <p> If the underlying class is an array class, then its
1332-
* {@code PUBLIC}, {@code PRIVATE} and {@code PROTECTED}
1333-
* access flags are the same as those of its component type. If this
1334-
* {@code Class} object represents a primitive type or void, the
1335-
* {@code PUBLIC} access flag is present, and the
1336-
* {@code PROTECTED} and {@code PRIVATE} access flags are always
1337-
* absent. If this {@code Class} object represents an array class, a
1338-
* primitive type or void, then the {@code FINAL} access flag is always
1339-
* present and the interface access flag is always
1340-
* absent. The values of its other access flags are not determined
1341-
* by this specification.
1336+
* <p> If the underlying class is an array class:
1337+
* <ul>
1338+
* <li> its {@code PUBLIC}, {@code PRIVATE} and {@code PROTECTED}
1339+
* access flags are the same as those of its component type
1340+
* <li> its {@code ABSTRACT} and {@code FINAL} flags are present
1341+
* <li> its {@code INTERFACE} flag is absent, even when the
1342+
* component type is an interface
1343+
* </ul>
1344+
* If this {@code Class} object represents a primitive type or
1345+
* void, the flags are {@code PUBLIC}, {@code ABSTRACT}, and
1346+
* {@code FINAL}.
1347+
* For {@code Class} objects representing void, primitive types, and
1348+
* arrays, access flags are absent other than as specified above.
13421349
*
13431350
* @see #getModifiers()
13441351
* @jvms 4.1 The ClassFile Structure

‎test/jdk/java/lang/Class/getModifiers/TestPrimitiveAndArrayModifiers.java

+136
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
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+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
import java.lang.reflect.Modifier;
25+
import java.lang.annotation.*;
26+
27+
/*
28+
* @test
29+
* @bug 8296743
30+
* @summary Verify array classes and primitives have expected modifiers
31+
*/
32+
@ExpectedModifiers(Modifier.PUBLIC | Modifier.FINAL | Modifier.ABSTRACT)
33+
public class TestPrimitiveAndArrayModifiers {
34+
35+
/*
36+
* Relevant excerpt of the Class.getModifiers() specification:
37+
* <p> If the underlying class is an array class:
38+
* <ul>
39+
* <li> its {@code public}, {@code private} and {@code protected}
40+
* modifiers are the same as those of its component type
41+
* <li> its {@code final} and {@code abstract} modifiers are always
42+
* {@code true}
43+
* <li> its interface modifier is always {@code false}, even when
44+
* the component type is an interface
45+
* </ul>
46+
*/
47+
48+
public static void main(String... args) throws Exception {
49+
testPrimitives();
50+
testArrays();
51+
}
52+
53+
private static void testArrays() {
54+
Class<?>[] testCases = {
55+
TestPrimitiveAndArrayModifiers.class,
56+
57+
PackagePrivateClass.class,
58+
ProtectedClass.class,
59+
PrivateClass.class,
60+
61+
PublicInterface.class,
62+
PackagePrivateInterface.class,
63+
ProtectedInterface.class,
64+
PrivateInterface.class,
65+
};
66+
67+
for(var testCase : testCases) {
68+
int expectedModifiers =
69+
testCase.getAnnotation(ExpectedModifiers.class).value();
70+
Class<?> arrayClass = testCase.arrayType();
71+
int actualModifiers = arrayClass.getModifiers();
72+
if (expectedModifiers != actualModifiers) {
73+
throw new RuntimeException("Expected " + Modifier.toString(expectedModifiers) +
74+
"on " + testCase.getCanonicalName() +
75+
", but got " + Modifier.toString(actualModifiers));
76+
}
77+
}
78+
}
79+
80+
@ExpectedModifiers(Modifier.FINAL | Modifier.ABSTRACT)
81+
class PackagePrivateClass {}
82+
83+
@ExpectedModifiers(Modifier.FINAL | Modifier.ABSTRACT | Modifier.PROTECTED)
84+
protected class ProtectedClass {}
85+
86+
@ExpectedModifiers(Modifier.FINAL | Modifier.ABSTRACT | Modifier.PRIVATE)
87+
private class PrivateClass {}
88+
89+
@ExpectedModifiers(Modifier.FINAL | Modifier.ABSTRACT | Modifier.PUBLIC)
90+
public interface PublicInterface {}
91+
92+
@ExpectedModifiers(Modifier.FINAL | Modifier.ABSTRACT)
93+
interface PackagePrivateInterface {}
94+
95+
@ExpectedModifiers(Modifier.FINAL | Modifier.ABSTRACT | Modifier.PROTECTED)
96+
protected interface ProtectedInterface {}
97+
98+
@ExpectedModifiers(Modifier.FINAL | Modifier.ABSTRACT | Modifier.PRIVATE)
99+
private interface PrivateInterface {}
100+
101+
/*
102+
* Relevant excerpt of the Class.getModifiers() specification:
103+
*
104+
* If this {@code Class} object represents a primitive type or
105+
* void, its {@code public}, {@code abstract}, and {@code final}
106+
* modifiers are always {@code true}.
107+
*/
108+
private static void testPrimitives() {
109+
Class<?>[] testCases = {
110+
void.class,
111+
boolean.class,
112+
byte.class,
113+
short.class,
114+
char.class,
115+
int.class,
116+
float.class,
117+
long.class,
118+
double.class,
119+
};
120+
121+
for(var testCase : testCases) {
122+
int actualModifiers = testCase.getModifiers();
123+
if ((Modifier.PUBLIC | Modifier.ABSTRACT | Modifier.FINAL) !=
124+
actualModifiers) {
125+
throw new RuntimeException("Bad modifiers " +
126+
Modifier.toString(actualModifiers) +
127+
" on primitive type " + testCase);
128+
}
129+
}
130+
}
131+
}
132+
133+
@Retention(RetentionPolicy.RUNTIME)
134+
@interface ExpectedModifiers {
135+
int value() default 0;
136+
}

‎test/jdk/java/lang/reflect/AccessFlag/ClassAccessFlagTest.java

+6-15
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
/*
2525
* @test
26-
* @bug 8266670 8291734
26+
* @bug 8266670 8291734 8296743
2727
* @summary Test expected AccessFlag's on classes.
2828
*/
2929

@@ -98,23 +98,14 @@ private static void checkPrimitives() {
9898
void.class // same access flag rules
9999
};
100100

101-
var mustBePresent = Set.of(AccessFlag.PUBLIC, AccessFlag.FINAL);
102-
var mustBeAbsent = Set.of(AccessFlag.PRIVATE,
103-
AccessFlag.PROTECTED,
104-
AccessFlag.INTERFACE);
101+
var expected = Set.of(AccessFlag.PUBLIC,
102+
AccessFlag.FINAL,
103+
AccessFlag.ABSTRACT);
105104

106105
for(var primClass : primitives) {
107-
// PUBLIC must be present, PROTECTED and PRIVATE must be
108-
// absent.
109-
// FINAL must be present, INTERFACE must be absent.
110106
var accessFlags = primClass.accessFlags();
111-
if (!accessFlags.containsAll(mustBePresent)) {
112-
throw new RuntimeException("Missing mandatory flags on " +
113-
primClass);
114-
}
115-
116-
if (containsAny(accessFlags, mustBeAbsent)) {
117-
throw new RuntimeException("Unexpected flags present on " +
107+
if (!accessFlags.equals(expected)) {
108+
throw new RuntimeException("Unexpected flags on " +
118109
primClass);
119110
}
120111
}

0 commit comments

Comments
 (0)
Please sign in to comment.