Skip to content

Commit c6753c2

Browse files
Update documentation.
1 parent 7d98309 commit c6753c2

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

src/jdk.internal.vm.ci/share/classes/jdk/vm/ci/meta/MemoryAccessProvider.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ public interface MemoryAccessProvider {
3535
* @param displacement the displacement within the object in bytes
3636
* @param bits the number of bits to read from memory
3737
* @return the read value encapsulated in a {@link JavaConstant} object of {@link JavaKind} kind
38-
* or {@code null} in case that the value could not be read
38+
* or {@code null} in case that the value could not be read (e.g., the final value is
39+
* not available at the time of this method execution)
3940
* @throws IllegalArgumentException if the read is out of bounds of the object or {@code kind}
4041
* is {@link JavaKind#Void} or not {@linkplain JavaKind#isPrimitive() primitive}
4142
* kind or {@code bits} is not 8, 16, 32 or 64, or the value cannot be read safely
@@ -48,9 +49,13 @@ public interface MemoryAccessProvider {
4849
*
4950
* @param base the base address from which the value is read
5051
* @param displacement the displacement within the object in bytes
51-
* @return the read value encapsulated in a {@link Constant} object
52+
* @return the read value encapsulated in a {@link Constant} object or {@code null} in case that
53+
* the value could not be read (e.g., the final value is not available at the time of
54+
* this method execution)
5255
* @throws IllegalArgumentException if the address computed from {@code base} and
53-
* {@code displacement} does not denote a location holding an {@code Object} value
56+
* {@code displacement} does not denote a location holding an {@code Object} value,
57+
* or if the value cannot be read safely (e.g., the final value is not available at
58+
* the time of this method execution)
5459
*/
5560
JavaConstant readObjectConstant(Constant base, long displacement);
5661
}

0 commit comments

Comments
 (0)