Skip to content

Commit 839fa20

Browse files
realityforgerealityforge
committed
Publish website
1 parent 2ffd632 commit 839fa20

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+10449
-10416
lines changed

‎api/allclasses-index.html‎

Lines changed: 157 additions & 153 deletions
Large diffs are not rendered by default.

‎api/arez/ArezContext.html‎

Lines changed: 193 additions & 291 deletions
Large diffs are not rendered by default.

‎api/arez/ComputableValue.Flags.html‎

Lines changed: 27 additions & 27 deletions
Large diffs are not rendered by default.

‎api/arez/ComputableValue.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,12 @@ <h1 title="Class ComputableValue" class="title">Class ComputableValue&lt;T&gt;</
8484
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name"><a href="../src-html/arez/ComputableValue.html#line-22">ComputableValue</a>&lt;T&gt;</span>
8585
<span class="extends-implements">extends <a href="Node.html" title="class in arez">Node</a></span></div>
8686
<div class="block">The ComputableValue represents an ObservableValue derived from other ObservableValues within
87-
the Arez system. The value is calculated lazily. i.e. The ComputableValue will only
87+
the Arez system. The value is calculated lazily. i.e., The ComputableValue will only
8888
be calculated if the ComputableValue has observers.
8989

9090
<p>It should be noted that the ComputableValue is backed by both an ObservableValue and
91-
an Observer. The id's of each of these nodes differ but they share the name and
92-
thus while debugging appear to be a single element.</p></div>
91+
an Observer. The id's of each of these nodes differ, but they share the name and
92+
thus while debugging appears to be a single element.</p></div>
9393
</section>
9494
<section class="summary">
9595
<ul class="summary-list">
@@ -173,9 +173,9 @@ <h2>Method Details</h2>
173173
<li>
174174
<section class="detail" id="get()">
175175
<h3>get</h3>
176-
<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-148">get</a></span>()</div>
176+
<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-134">get</a></span>()</div>
177177
<div class="block">Return the computable value, calculating the value if it is not up to date.
178-
Before invoking this method, a transaction <b>MUST</b> be active but it may be read-only or read-write.</div>
178+
Before invoking this method, a transaction <b>MUST</b> be active, but it may be read-only or read-write.</div>
179179
<dl class="notes">
180180
<dt>Returns:</dt>
181181
<dd>the computable value.</dd>
@@ -185,9 +185,9 @@ <h3>get</h3>
185185
<li>
186186
<section class="detail" id="reportPossiblyChanged()">
187187
<h3>reportPossiblyChanged</h3>
188-
<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-212">reportPossiblyChanged</a></span>()</div>
188+
<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-198">reportPossiblyChanged</a></span>()</div>
189189
<div class="block">Invoked when a non-arez dependency of the ComputableValue has changed. The ComputableValue
190-
may or may not change as a result of the dependency change but Arez will recalculate
190+
may or may not change as a result of the dependency change, but Arez will recalculate
191191
the ComputableValue during the normal reaction cycle or when next accessed and will propagate
192192
the change at that time if required. This method must be explicitly invoked by the
193193
developer if the ComputableValue is derived from non-arez data and that data changes.
@@ -197,14 +197,14 @@ <h3>reportPossiblyChanged</h3>
197197
<li>
198198
<section class="detail" id="dispose()">
199199
<h3>dispose</h3>
200-
<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-241">dispose</a></span>()</div>
200+
<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-227">dispose</a></span>()</div>
201201
<div class="block">Dispose the ComputableValue so that it can no longer be used.</div>
202202
</section>
203203
</li>
204204
<li>
205205
<section class="detail" id="isDisposed()">
206206
<h3>isDisposed</h3>
207-
<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-277">isDisposed</a></span>()</div>
207+
<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-263">isDisposed</a></span>()</div>
208208
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Disposable.html#isDisposed()">Disposable</a></code></span></div>
209209
<div class="block">Return true if dispose() has been called on object.</div>
210210
<dl class="notes">
@@ -216,11 +216,11 @@ <h3>isDisposed</h3>
216216
<li>
217217
<section class="detail" id="keepAlive()">
218218
<h3>keepAlive</h3>
219-
<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-298">keepAlive</a></span>()</div>
219+
<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-284">keepAlive</a></span>()</div>
220220
<div class="block">Invoke this method to ensure that the ComputableValue is activated and computing
221221
a value even if there are no observers. This is used when there is a chance that
222222
the value will be accessed multiple times, without being accessed from within a
223-
tracking transaction (i.e. the value may only be accessed from actions or may have
223+
tracking transaction (i.e., the value may only be accessed from actions or may have
224224
observers come and go).
225225

226226
<p>This method should not be called if the computable value was created with the

‎api/arez/Hook.html‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) -->
5+
<title>Hook (Arez API Documentation)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8+
<meta name="description" content="declaration: package: arez, class: Hook">
9+
<meta name="generator" content="javadoc/ClassWriterImpl">
10+
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
11+
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
13+
<script type="text/javascript" src="../script.js"></script>
14+
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
15+
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="class-declaration-page">
18+
<script type="text/javascript">var pathtoroot = "../";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top">
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="../index.html">Overview</a></li>
31+
<li><a href="package-summary.html">Package</a></li>
32+
<li class="nav-bar-cell1-rev">Class</li>
33+
<li><a href="package-tree.html">Tree</a></li>
34+
<li><a href="../index-all.html">Index</a></li>
35+
<li><a href="../help-doc.html#class">Help</a></li>
36+
</ul>
37+
</div>
38+
<div class="sub-nav">
39+
<div>
40+
<ul class="sub-nav-list">
41+
<li>Summary:&nbsp;</li>
42+
<li>Nested&nbsp;|&nbsp;</li>
43+
<li>Field&nbsp;|&nbsp;</li>
44+
<li>Constr&nbsp;|&nbsp;</li>
45+
<li><a href="#method-summary">Method</a></li>
46+
</ul>
47+
<ul class="sub-nav-list">
48+
<li>Detail:&nbsp;</li>
49+
<li>Field&nbsp;|&nbsp;</li>
50+
<li>Constr&nbsp;|&nbsp;</li>
51+
<li>Method</li>
52+
</ul>
53+
</div>
54+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
55+
<input type="text" id="search-input" value="search" disabled="disabled">
56+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
57+
</div>
58+
</div>
59+
<!-- ========= END OF TOP NAVBAR ========= -->
60+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
61+
</header>
62+
<div class="flex-content">
63+
<main role="main">
64+
<!-- ======== START OF CLASS DATA ======== -->
65+
<div class="header">
66+
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">arez</a></div>
67+
<h1 title="Class Hook" class="title">Class Hook</h1>
68+
</div>
69+
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
70+
<div class="inheritance">arez.Hook</div>
71+
</div>
72+
<section class="class-description" id="class-description">
73+
<hr>
74+
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name"><a href="../src-html/arez/Hook.html#line-8">Hook</a></span>
75+
<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>
76+
<div class="block">Hook that can be registered for the current observer.</div>
77+
</section>
78+
<section class="summary">
79+
<ul class="summary-list">
80+
<!-- ========== METHOD SUMMARY =========== -->
81+
<li>
82+
<section class="method-summary" id="method-summary">
83+
<h2>Method Summary</h2>
84+
<div class="inherited-list">
85+
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<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></h3>
86+
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
87+
</section>
88+
</li>
89+
</ul>
90+
</section>
91+
<!-- ========= END OF CLASS DATA ========= -->
92+
</main>
93+
</div>
94+
</div>
95+
</body>
96+
</html>

0 commit comments

Comments
 (0)