diff graal/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/ConditionProfile.java @ 16868:db090a8d3705

clarify documentation about assumption and profile storage in final fields
author Michael Haupt <michael.haupt@oracle.com>
date Wed, 20 Aug 2014 15:16:11 +0200
parents fa5e62620593
children c9437b07c26a
line wrap: on
line diff
--- a/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/ConditionProfile.java	Tue Aug 19 19:25:44 2014 +0200
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/ConditionProfile.java	Wed Aug 20 15:16:11 2014 +0200
@@ -34,7 +34,7 @@
  *
  * <pre>
  * private final ConditionProfile zero = ConditionProfile.createBinaryProfile();
- *
+ * 
  * int value = ...;
  * if (zero.profile(value == 0)) {
  *   return 0;
@@ -44,6 +44,9 @@
  *
  * </pre>
  *
+ * All instances of {@code ConditionProfile} (and subclasses) must be held in {@code final} fields
+ * for compiler optimizations to take effect.
+ *
  * @see #createCountingProfile()
  * @see #createBinaryProfile()
  */