Publish website

Author: realityforge

api/arez/component/ComponentObservable.html

@@ -145,10 +145,8 @@ <h3>observe</h3>
 <li>
 <section class="detail" id="observe(java.lang.Object)">
 <h3>observe</h3>
-<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/ComponentObservable.html#line-31">observe</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;object)</span></div>
-<div class="block">Invoke <a href="#observe()"><code>observe()</code></a> on the supplied object if any.
- If a null object is passed into this method then it will return true.
- If an object that is not an instance of <a href="ComponentObservable.html" title="interface in arez.component"><code>ComponentObservable</code></a> is passed into this method then it will return true.</div>
+<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/ComponentObservable.html#line-29">observe</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;object)</span></div>
+<div class="block">Invoke <a href="#observe()"><code>observe()</code></a> on the supplied object if any.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>object</code> - the object to observe if any.</dd>
@@ -160,7 +158,7 @@ <h3>observe</h3>
 <li>
 <section class="detail" id="notObserved(java.lang.Object)">
 <h3>notObserved</h3>
-<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/ComponentObservable.html#line-42">notObserved</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;object)</span></div>
+<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/ComponentObservable.html#line-40">notObserved</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;object)</span></div>
 <div class="block">Return true if <a href="#observe(java.lang.Object)"><code>observe(Object)</code></a> returns false for the same parameter.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
@@ -173,7 +171,7 @@ <h3>notObserved</h3>
 <li>
 <section class="detail" id="asComponentObservable(java.lang.Object)">
 <h3>asComponentObservable</h3>
-<div class="member-signature"><span class="annotations">@Nonnull </span><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="ComponentObservable.html" title="interface in arez.component">ComponentObservable</a></span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/ComponentObservable.html#line-54">asComponentObservable</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;object)</span></div>
+<div class="member-signature"><span class="annotations">@Nonnull </span><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="ComponentObservable.html" title="interface in arez.component">ComponentObservable</a></span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/ComponentObservable.html#line-52">asComponentObservable</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;object)</span></div>
 <div class="block">Cast specified object to an instance of ComponentObservable.
  Invariant checks will verify that the cast is valid before proceeding.</div>
 <dl class="notes">

api/arez/component/DisposeNotifier.html

@@ -88,24 +88,35 @@ <h1 title="Interface DisposeNotifier" class="title">Interface DisposeNotifier</h
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
-<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
+<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addOnDisposeListener(java.lang.Object,arez.SafeProcedure,boolean)" class="member-name-link">addOnDisposeListener</a><wbr>(<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>&nbsp;key,
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#addOnDisposeListener(java.lang.Object,arez.SafeProcedure)" class="member-name-link">addOnDisposeListener</a><wbr>(<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>&nbsp;key,
+ <a href="../SafeProcedure.html" title="interface in arez">SafeProcedure</a>&nbsp;action)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
+<div class="block">Add the listener to the notify list under key.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addOnDisposeListener(java.lang.Object,arez.SafeProcedure,boolean)" class="member-name-link">addOnDisposeListener</a><wbr>(<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>&nbsp;key,
  <a href="../SafeProcedure.html" title="interface in arez">SafeProcedure</a>&nbsp;action,
  boolean&nbsp;errorIfDuplicate)</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Add the listener to the notify list under key.</div>
 </div>
-<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="DisposeNotifier.html" title="interface in arez.component">DisposeNotifier</a></code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#asDisposeNotifier(java.lang.Object)" class="member-name-link">asDisposeNotifier</a><wbr>(<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>&nbsp;object)</code></div>
-<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
+<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="DisposeNotifier.html" title="interface in arez.component">DisposeNotifier</a></code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#asDisposeNotifier(java.lang.Object)" class="member-name-link">asDisposeNotifier</a><wbr>(<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>&nbsp;object)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
 <div class="block">Cast the specified object to an instance of DisposeNotifier.</div>
 </div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#removeOnDisposeListener(java.lang.Object)" class="member-name-link">removeOnDisposeListener</a><wbr>(<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>&nbsp;key)</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
+<div class="block">Remove the listener with the specified key from the notify list.</div>
+</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeOnDisposeListener(java.lang.Object,boolean)" class="member-name-link">removeOnDisposeListener</a><wbr>(<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>&nbsp;key,
  boolean&nbsp;errorIfMissing)</code></div>
@@ -149,9 +160,29 @@ <h3>addOnDisposeListener</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="addOnDisposeListener(java.lang.Object,arez.SafeProcedure)">
+<h3>addOnDisposeListener</h3>
+<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/DisposeNotifier.html#line-49">addOnDisposeListener</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;key,
+ @Nonnull <a href="../SafeProcedure.html" title="interface in arez">SafeProcedure</a>&nbsp;action)</span></div>
+<div class="block">Add the listener to the notify list under key.
+ This method MUST NOT be invoked after the component has been disposed.
+ This method should not be invoked if another listener has been added with the same key without
+ being removed.
+
+ <p>If the key implements <a href="../Disposable.html" title="interface in arez"><code>Disposable</code></a> and <a href="../Disposable.html#isDisposed()"><code>Disposable.isDisposed()</code></a> returns <code>true</code>
+ when invoking the calback then the callback will be skipped. This rare situation only occurs when there is
+ circular dependency in the object model usually involving <a href="../annotations/CascadeDispose.html" title="annotation interface in arez.annotations"><code>CascadeDispose</code></a>.</p></div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>key</code> - the key to uniquely identify listener.</dd>
+<dd><code>action</code> - the listener callback.</dd>
+</dl>
+</section>
+</li>
+<li>
 <section class="detail" id="removeOnDisposeListener(java.lang.Object,boolean)">
 <h3>removeOnDisposeListener</h3>
-<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/DisposeNotifier.html#line-45">removeOnDisposeListener</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;key,
+<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/DisposeNotifier.html#line-63">removeOnDisposeListener</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;key,
  boolean&nbsp;errorIfMissing)</span></div>
 <div class="block">Remove the listener with the specified key from the notify list.
  This method should only be invoked when a listener has been added for specific key using
@@ -165,9 +196,23 @@ <h3>removeOnDisposeListener</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="removeOnDisposeListener(java.lang.Object)">
+<h3>removeOnDisposeListener</h3>
+<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/DisposeNotifier.html#line-73">removeOnDisposeListener</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;key)</span></div>
+<div class="block">Remove the listener with the specified key from the notify list.
+ This method should only be invoked when a listener has been added for specific key using
+ <a href="#addOnDisposeListener(java.lang.Object,arez.SafeProcedure,boolean)"><code>addOnDisposeListener(Object, SafeProcedure, boolean)</code></a> and has not been removed by another
+ call to this method.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>key</code> - the key under which the listener was previously added.</dd>
+</dl>
+</section>
+</li>
+<li>
 <section class="detail" id="asDisposeNotifier(java.lang.Object)">
 <h3>asDisposeNotifier</h3>
-<div class="member-signature"><span class="annotations">@Nonnull </span><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DisposeNotifier.html" title="interface in arez.component">DisposeNotifier</a></span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/DisposeNotifier.html#line-54">asDisposeNotifier</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;object)</span></div>
+<div class="member-signature"><span class="annotations">@Nonnull </span><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="DisposeNotifier.html" title="interface in arez.component">DisposeNotifier</a></span>&nbsp;<span class="element-name"><a href="../../src-html/arez/component/DisposeNotifier.html#line-85">asDisposeNotifier</a></span><wbr><span class="parameters">(@Nonnull <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>&nbsp;object)</span></div>
 <div class="block">Cast the specified object to an instance of DisposeNotifier.
  Invariant checks will verify that the cast is valid before proceeding.</div>
 <dl class="notes">

api/index-all.html

@@ -146,6 +146,10 @@ <h2 class="title" id="I:A">A</h2>
 <dd>
 <div class="block">Add error handler to the list of error handlers called.</div>
 </dd>
+<dt><a href="arez/component/DisposeNotifier.html#addOnDisposeListener(java.lang.Object,arez.SafeProcedure)" class="member-name-link">addOnDisposeListener(Object, SafeProcedure)</a> - Method in interface arez.component.<a href="arez/component/DisposeNotifier.html" title="interface in arez.component">DisposeNotifier</a></dt>
+<dd>
+<div class="block">Add the listener to the notify list under key.</div>
+</dd>
 <dt><a href="arez/component/internal/ComponentKernel.html#addOnDisposeListener(java.lang.Object,arez.SafeProcedure)" class="member-name-link">addOnDisposeListener(Object, SafeProcedure)</a> - Method in class arez.component.internal.<a href="arez/component/internal/ComponentKernel.html" title="class in arez.component.internal">ComponentKernel</a></dt>
 <dd>
 <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
@@ -2593,6 +2597,10 @@ <h2 class="title" id="I:R">R</h2>
 <dd>
 <div class="block">Remove error handler from list of existing error handlers.</div>
 </dd>
+<dt><a href="arez/component/DisposeNotifier.html#removeOnDisposeListener(java.lang.Object)" class="member-name-link">removeOnDisposeListener(Object)</a> - Method in interface arez.component.<a href="arez/component/DisposeNotifier.html" title="interface in arez.component">DisposeNotifier</a></dt>
+<dd>
+<div class="block">Remove the listener with the specified key from the notify list.</div>
+</dd>
 <dt><a href="arez/component/internal/ComponentKernel.html#removeOnDisposeListener(java.lang.Object)" class="member-name-link">removeOnDisposeListener(Object)</a> - Method in class arez.component.internal.<a href="arez/component/internal/ComponentKernel.html" title="class in arez.component.internal">ComponentKernel</a></dt>
 <dd>
 <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>