Skip to content

Commit

Permalink
Publish website
Browse files Browse the repository at this point in the history
  • Loading branch information
realityforge committed Jan 14, 2025
1 parent 2ffd632 commit 839fa20
Show file tree
Hide file tree
Showing 63 changed files with 10,449 additions and 10,416 deletions.
310 changes: 157 additions & 153 deletions api/allclasses-index.html

Large diffs are not rendered by default.

484 changes: 193 additions & 291 deletions api/arez/ArezContext.html

Large diffs are not rendered by default.

54 changes: 27 additions & 27 deletions api/arez/ComputableValue.Flags.html

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions api/arez/ComputableValue.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@ <h1 title="Class ComputableValue" class="title">Class ComputableValue&lt;T&gt;</
<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>
<span class="extends-implements">extends <a href="Node.html" title="class in arez">Node</a></span></div>
<div class="block">The ComputableValue represents an ObservableValue derived from other ObservableValues within
the Arez system. The value is calculated lazily. i.e. The ComputableValue will only
the Arez system. The value is calculated lazily. i.e., The ComputableValue will only
be calculated if the ComputableValue has observers.

<p>It should be noted that the ComputableValue is backed by both an ObservableValue and
an Observer. The id's of each of these nodes differ but they share the name and
thus while debugging appear to be a single element.</p></div>
an Observer. The id's of each of these nodes differ, but they share the name and
thus while debugging appears to be a single element.</p></div>
</section>
<section class="summary">
<ul class="summary-list">
Expand Down Expand Up @@ -173,9 +173,9 @@ <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-148">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-134">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>
Before invoking this method, a transaction <b>MUST</b> be active, but it may be read-only or read-write.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the computable value.</dd>
Expand All @@ -185,9 +185,9 @@ <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-212">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-198">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
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
the change at that time if required. This method must be explicitly invoked by the
developer if the ComputableValue is derived from non-arez data and that data changes.
Expand All @@ -197,14 +197,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-241">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-227">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-277">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-263">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">
Expand All @@ -216,11 +216,11 @@ <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-298">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-284">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
tracking transaction (i.e. the value may only be accessed from actions or may have
tracking transaction (i.e., the value may only be accessed from actions or may have
observers come and go).

<p>This method should not be called if the computable value was created with the
Expand Down
96 changes: 96 additions & 0 deletions api/arez/Hook.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Hook (Arez API Documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: arez, class: Hook">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">arez</a></div>
<h1 title="Class Hook" class="title">Class Hook</h1>
</div>
<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>
<div class="inheritance">arez.Hook</div>
</div>
<section class="class-description" id="class-description">
<hr>
<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>
<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">Hook that can be registered for the current observer.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div class="inherited-list">
<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>
<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>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Loading

0 comments on commit 839fa20

Please sign in to comment.