Publish website

Author: realityforge

api/allclasses-index.html

@@ -76,7 +76,7 @@ <h1 title="Class ComputableValue.Flags" class="title">Class ComputableValue.Flag
 <dd><a href="ComputableValue.html" title="class in arez">ComputableValue</a>&lt;<a href="ComputableValue.html" title="type parameter in ComputableValue">T</a>&gt;</dd>
 </dl>
 <hr>
-<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-561">ComputableValue.Flags</a></span>
+<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-577">ComputableValue.Flags</a></span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
 <div class="block">Flags that can configure ComputableValue instances during creation.</div>
 </section>
@@ -207,7 +207,7 @@ <h2>Field Details</h2>
 <li>
 <section class="detail" id="RUN_NOW">
 <h3>RUN_NOW</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-569">RUN_NOW</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-585">RUN_NOW</a></span></div>
 <div class="block">The scheduler will be triggered when the ComputableValue is created to immediately invoke the
  compute function. This should not be specified if <a href="#RUN_LATER"><code>RUN_LATER</code></a> is specified.</div>
 <dl class="notes">
@@ -224,7 +224,7 @@ <h3>RUN_NOW</h3>
 <li>
 <section class="detail" id="RUN_LATER">
 <h3>RUN_LATER</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-577">RUN_LATER</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-593">RUN_LATER</a></span></div>
 <div class="block">The scheduler will not be triggered when the ComputableValue is created. The ComputableValue
  is responsible for ensuring that <a href="ArezContext.html#triggerScheduler()"><code>ArezContext.triggerScheduler()</code></a> is invoked at a later
  time. This should not be specified if <a href="#RUN_NOW"><code>RUN_NOW</code></a> is specified.</div>
@@ -242,7 +242,7 @@ <h3>RUN_LATER</h3>
 <li>
 <section class="detail" id="NO_REPORT_RESULT">
 <h3>NO_REPORT_RESULT</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-583">NO_REPORT_RESULT</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-599">NO_REPORT_RESULT</a></span></div>
 <div class="block">If passed, then the computable value should not report result to the spy infrastructure.</div>
 <dl class="notes">
 <dt>See Also:</dt>
@@ -258,7 +258,7 @@ <h3>NO_REPORT_RESULT</h3>
 <li>
 <section class="detail" id="AREZ_DEPENDENCIES">
 <h3>AREZ_DEPENDENCIES</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-591">AREZ_DEPENDENCIES</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-607">AREZ_DEPENDENCIES</a></span></div>
 <div class="block">Indicates that application code cannot invoke <a href="ComputableValue.html#reportPossiblyChanged()"><code>ComputableValue.reportPossiblyChanged()</code></a>
  and the <a href="ComputableValue.html" title="class in arez"><code>ComputableValue</code></a> is only recalculated if a dependency is updated.</div>
 <dl class="notes">
@@ -276,7 +276,7 @@ <h3>AREZ_DEPENDENCIES</h3>
 <li>
 <section class="detail" id="AREZ_OR_NO_DEPENDENCIES">
 <h3>AREZ_OR_NO_DEPENDENCIES</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-599">AREZ_OR_NO_DEPENDENCIES</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-615">AREZ_OR_NO_DEPENDENCIES</a></span></div>
 <div class="block">Flag set if the application code cannot invoke <a href="ComputableValue.html#reportPossiblyChanged()"><code>ComputableValue.reportPossiblyChanged()</code></a> to
  indicate that a dependency has changed.</div>
 <dl class="notes">
@@ -294,7 +294,7 @@ <h3>AREZ_OR_NO_DEPENDENCIES</h3>
 <li>
 <section class="detail" id="AREZ_OR_EXTERNAL_DEPENDENCIES">
 <h3>AREZ_OR_EXTERNAL_DEPENDENCIES</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-607">AREZ_OR_EXTERNAL_DEPENDENCIES</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-623">AREZ_OR_EXTERNAL_DEPENDENCIES</a></span></div>
 <div class="block">Indicates that application code can invoke <a href="ComputableValue.html#reportPossiblyChanged()"><code>ComputableValue.reportPossiblyChanged()</code></a> to
  indicate some dependency has changed and that the <a href="ComputableValue.html" title="class in arez"><code>ComputableValue</code></a> should recompute.</div>
 <dl class="notes">
@@ -312,7 +312,7 @@ <h3>AREZ_OR_EXTERNAL_DEPENDENCIES</h3>
 <li>
 <section class="detail" id="OBSERVE_LOWER_PRIORITY_DEPENDENCIES">
 <h3>OBSERVE_LOWER_PRIORITY_DEPENDENCIES</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-613">OBSERVE_LOWER_PRIORITY_DEPENDENCIES</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-629">OBSERVE_LOWER_PRIORITY_DEPENDENCIES</a></span></div>
 <div class="block">Flag indicating that the ComputableValue is allowed to observe <a href="ComputableValue.html" title="class in arez"><code>ComputableValue</code></a> instances with a lower priority.</div>
 <dl class="notes">
 <dt>See Also:</dt>
@@ -328,7 +328,7 @@ <h3>OBSERVE_LOWER_PRIORITY_DEPENDENCIES</h3>
 <li>
 <section class="detail" id="KEEPALIVE">
 <h3>KEEPALIVE</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-619">KEEPALIVE</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-635">KEEPALIVE</a></span></div>
 <div class="block">The runtime will keep the ComputableValue reacting to dependencies until disposed.</div>
 <dl class="notes">
 <dt>See Also:</dt>
@@ -344,7 +344,7 @@ <h3>KEEPALIVE</h3>
 <li>
 <section class="detail" id="PRIORITY_HIGHEST">
 <h3>PRIORITY_HIGHEST</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-630">PRIORITY_HIGHEST</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-646">PRIORITY_HIGHEST</a></span></div>
 <div class="block">Highest priority.
  This priority should be used when the ComputableValue will dispose or release other reactive elements
  (and thus remove elements from being scheduled).
@@ -365,7 +365,7 @@ <h3>PRIORITY_HIGHEST</h3>
 <li>
 <section class="detail" id="PRIORITY_HIGH">
 <h3>PRIORITY_HIGH</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-642">PRIORITY_HIGH</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-658">PRIORITY_HIGH</a></span></div>
 <div class="block">High priority.
  To reduce the chance that downstream elements will react multiple times within a single
  reaction round, this priority should be used when the ComputableValue may trigger many downstream
@@ -387,7 +387,7 @@ <h3>PRIORITY_HIGH</h3>
 <li>
 <section class="detail" id="PRIORITY_NORMAL">
 <h3>PRIORITY_NORMAL</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-651">PRIORITY_NORMAL</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-667">PRIORITY_NORMAL</a></span></div>
 <div class="block">Normal priority if no other priority otherwise specified.
  <p>Only one of the PRIORITY_* flags should be applied to ComputableValue.</p></div>
 <dl class="notes">
@@ -406,7 +406,7 @@ <h3>PRIORITY_NORMAL</h3>
 <li>
 <section class="detail" id="PRIORITY_LOW">
 <h3>PRIORITY_LOW</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-665">PRIORITY_LOW</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-681">PRIORITY_LOW</a></span></div>
 <div class="block">Low priority.
  Usually used to schedule ComputableValues that support reflecting state onto non-reactive
  application components. i.e., ComputableValue that are used to build html views,
@@ -430,7 +430,7 @@ <h3>PRIORITY_LOW</h3>
 <li>
 <section class="detail" id="PRIORITY_LOWEST">
 <h3>PRIORITY_LOWEST</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-676">PRIORITY_LOWEST</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-692">PRIORITY_LOWEST</a></span></div>
 <div class="block">Lowest priority. Use this priority if the ComputableValue may be unobserved when
  a <a href="#PRIORITY_LOW"><code>PRIORITY_LOW</code></a> element reacts. This is used to avoid recomputing state, that is
  likely to either be unobserved or recomputed as part of another element's reaction.
@@ -451,7 +451,7 @@ <h3>PRIORITY_LOWEST</h3>
 <li>
 <section class="detail" id="PRIORITY_MASK">
 <h3>PRIORITY_MASK</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-680">PRIORITY_MASK</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-696">PRIORITY_MASK</a></span></div>
 <div class="block">Mask used to extract priority bits.</div>
 <dl class="notes">
 <dt>See Also:</dt>
@@ -466,7 +466,7 @@ <h3>PRIORITY_MASK</h3>
 <li>
 <section class="detail" id="READ_OUTSIDE_TRANSACTION">
 <h3>READ_OUTSIDE_TRANSACTION</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-684">READ_OUTSIDE_TRANSACTION</a></span></div>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-700">READ_OUTSIDE_TRANSACTION</a></span></div>
 <div class="block">Flag indicating that the ComputableValue be accessed outside a transaction.</div>
 <dl class="notes">
 <dt>See Also:</dt>
@@ -489,7 +489,7 @@ <h2>Constructor Details</h2>
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>Flags</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-561">Flags</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.Flags.html#line-577">Flags</a></span>()</div>
 </section>
 </li>
 </ul>

api/arez/ArezContext.html

@@ -174,7 +174,7 @@ <h2>Method Details</h2>
 <li>
 <section class="detail" id="get()">
 <h3>get</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ComputableValue.html" title="type parameter in ComputableValue">T</a></span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-133">get</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ComputableValue.html" title="type parameter in ComputableValue">T</a></span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-149">get</a></span>()</div>
 <div class="block">Return the computable value, calculating the value if it is not up to date.
  Before invoking this method, a transaction <b>MUST</b> be active, but it may be read-only or read-write.</div>
 <dl class="notes">
@@ -186,7 +186,7 @@ <h3>get</h3>
 <li>
 <section class="detail" id="reportPossiblyChanged()">
 <h3>reportPossiblyChanged</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-197">reportPossiblyChanged</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-213">reportPossiblyChanged</a></span>()</div>
 <div class="block">Invoked when a non-arez dependency of the ComputableValue has changed. The ComputableValue
  may or may not change as a result of the dependency change, but Arez will recalculate
  the ComputableValue during the normal reaction cycle or when next accessed and will propagate
@@ -198,14 +198,14 @@ <h3>reportPossiblyChanged</h3>
 <li>
 <section class="detail" id="dispose()">
 <h3>dispose</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-226">dispose</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-242">dispose</a></span>()</div>
 <div class="block">Dispose the ComputableValue so that it can no longer be used.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="isDisposed()">
 <h3>isDisposed</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-262">isDisposed</a></span>()</div>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-278">isDisposed</a></span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Disposable.html#isDisposed()">Disposable</a></code></span></div>
 <div class="block">Return true if dispose() has been called on object.</div>
 <dl class="notes">
@@ -217,7 +217,7 @@ <h3>isDisposed</h3>
 <li>
 <section class="detail" id="keepAlive()">
 <h3>keepAlive</h3>
-<div class="member-signature"><span class="annotations">@Nonnull </span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Disposable.html" title="interface in arez">Disposable</a></span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-283">keepAlive</a></span>()</div>
+<div class="member-signature"><span class="annotations">@Nonnull </span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Disposable.html" title="interface in arez">Disposable</a></span>&nbsp;<span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-299">keepAlive</a></span>()</div>
 <div class="block">Invoke this method to ensure that the ComputableValue is activated and computing
  a value even if there are no observers. This is used when there is a chance that
  the value will be accessed multiple times, without being accessed from within a