[GR-49481] Document explicit NPE for GraphBuilderContext#nullCheckedV…

…alue.
oracle · Dec 20, 2023 · e31b87d · e31b87d
1 parent 4c79426
commit e31b87d
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/...jdk.graal.compiler/src/jdk/graal/compiler/nodes/graphbuilderconf/GraphBuilderContext.java b/...jdk.graal.compiler/src/jdk/graal/compiler/nodes/graphbuilderconf/GraphBuilderContext.java
@@ -318,6 +318,11 @@ default boolean isPluginEnabled(GraphBuilderPlugin plugin) {
 
     BailoutException bailout(String string);
 
+    /**
+     * Gets a version of a given value that has a non-null stamp. Emits a guard or an explicit
+     * exception check which is triggered if the value is null. Thus, <b> use only for values where
+     * the underlying bytecode can throw a {@link NullPointerException}! </b>
+     */
     default ValueNode nullCheckedValue(ValueNode value) {
         return nullCheckedValue(value, InvalidateReprofile);
     }
@@ -336,8 +341,9 @@ default GuardingNode intrinsicRangeCheck(LogicNode condition, boolean negated) {
     }
 
     /**
-     * Gets a version of a given value that has a {@linkplain StampTool#isPointerNonNull(ValueNode)
-     * non-null} stamp.
+     * Gets a version of a given value that has a non-null stamp. Emits a guard or an explicit
+     * exception check which is triggered if the value is null. Thus, <b> use only for values where
+     * the underlying bytecode can throw a {@link NullPointerException}! </b>
      */
     default ValueNode nullCheckedValue(ValueNode value, DeoptimizationAction action) {
         if (!StampTool.isPointerNonNull(value)) {