Publish website

Author: realityforge

api-diff/data/react4j/0.187-0.188.json

@@ -0,0 +1,18 @@
+[
+  {
+    "code": "java.method.attributeRemovedFromAnnotationType",
+    "description": "The annotation no longer has an attribute.",
+    "oldElement": "method react4j.annotations.Feature react4j.annotations.Input::shouldUpdateOnChange()",
+    "classification": {
+      "SOURCE": "BREAKING",
+      "BINARY": "BREAKING"
+    },
+    "attachments": {
+      "classQualifiedName": "react4j.annotations.Input",
+      "classSimpleName": "Input",
+      "elementKind": "method",
+      "methodName": "shouldUpdateOnChange",
+      "package": "react4j.annotations"
+    }
+  }
+]

api/react4j/annotations/Input.Source.html

@@ -120,7 +120,7 @@ <h2 title="Enum Input.Source" class="title">Enum Input.Source</h2>
 </dl>
 <hr>
 <br>
-<pre>public static enum <a href="../../src-html/react4j/annotations/Input.html#line.161">Input.Source</a>
+<pre>public static enum <a href="../../src-html/react4j/annotations/Input.html#line.152">Input.Source</a>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a>&gt;</pre>
 <div class="block">Enum where the input is sourced from.</div>
 </li>
@@ -213,7 +213,7 @@ <h3>Enum Constant Detail</h3>
 <ul class="blockList">
 <li class="blockList">
 <h4>DEFAULT</h4>
-<pre>public static final&nbsp;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a> <a href="../../src-html/react4j/annotations/Input.Source.html#line.166">DEFAULT</a></pre>
+<pre>public static final&nbsp;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a> <a href="../../src-html/react4j/annotations/Input.Source.html#line.157">DEFAULT</a></pre>
 <div class="block">The input value is passed to the view during construction.</div>
 </li>
 </ul>
@@ -223,7 +223,7 @@ <h4>DEFAULT</h4>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>CONTEXT</h4>
-<pre>public static final&nbsp;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a> <a href="../../src-html/react4j/annotations/Input.Source.html#line.170">CONTEXT</a></pre>
+<pre>public static final&nbsp;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a> <a href="../../src-html/react4j/annotations/Input.Source.html#line.161">CONTEXT</a></pre>
 <div class="block">The input value is retrieved from the react context.</div>
 </li>
 </ul>
@@ -241,7 +241,7 @@ <h3>Method Detail</h3>
 <ul class="blockList">
 <li class="blockList">
 <h4>values</h4>
-<pre>public static&nbsp;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a>[]&nbsp;<a href="../../src-html/react4j/annotations/Input.Source.html#line.161">values</a>()</pre>
+<pre>public static&nbsp;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a>[]&nbsp;<a href="../../src-html/react4j/annotations/Input.Source.html#line.152">values</a>()</pre>
 <div class="block">Returns an array containing the constants of this enum type, in
 the order they are declared.  This method may be used to iterate
 over the constants as follows:
@@ -261,7 +261,7 @@ <h4>values</h4>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>valueOf</h4>
-<pre>public static&nbsp;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.Source.html#line.161">valueOf</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
+<pre>public static&nbsp;<a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.Source.html#line.152">valueOf</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
 <div class="block">Returns the enum constant of this type with the specified name.
 The string must match <i>exactly</i> an identifier used to declare an
 enum constant in this type.  (Extraneous whitespace characters are 

api/react4j/annotations/Input.html

@@ -180,12 +180,6 @@ <h3>Optional Element Summary</h3>
 </td>
 </tr>
 <tr class="rowColor">
-<td class="colFirst"><code><a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../react4j/annotations/Input.html#shouldUpdateOnChange--">shouldUpdateOnChange</a></span></code>
-<div class="block">Indicate whether changing the value of the input should schedule a re-render.</div>
-</td>
-</tr>
-<tr class="altColor">
 <td class="colFirst"><code><a href="../../react4j/annotations/Input.Source.html" title="enum in react4j.annotations">Input.Source</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../react4j/annotations/Input.html#source--">source</a></span></code>
 <div class="block">The setting controlling where the input value is source from.</div>
@@ -305,41 +299,18 @@ <h4>require</h4>
 </li>
 </ul>
 <ul class="blockList">
-<li class="blockList"><a name="shouldUpdateOnChange--">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>shouldUpdateOnChange</h4>
-<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.95">shouldUpdateOnChange</a></pre>
-<div class="block">Indicate whether changing the value of the input should schedule a re-render.
- If set to <a href="../../react4j/annotations/Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will treat it as
- <a href="../../react4j/annotations/Feature.html#ENABLE"><code>Feature.ENABLE</code></a> unless <a href="../../react4j/annotations/Input.html#immutable--"><code>immutable()</code></a> is set to <code>true</code>.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the enum indicating whether input should trigger a render if it is modified.</dd>
-</dl>
-<dl>
-<dt>Default:</dt>
-<dd>react4j.annotations.Feature.AUTODETECT</dd>
-</dl>
-</li>
-</ul>
-</li>
-</ul>
-<ul class="blockList">
 <li class="blockList"><a name="observable--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>observable</h4>
-<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.108">observable</a></pre>
+<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.99">observable</a></pre>
 <div class="block">Indicate whether the input should be annotated by <a href="https://arez.github.io/api/arez/annotations/Observable.html?is-external=true" title="class or interface in arez.annotations"><code>Observable</code></a>.
 
  <p>If set to <a href="../../react4j/annotations/Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the input will be observable if and only if:</p>
  <ul>
- <li><a href="../../react4j/annotations/Input.html#shouldUpdateOnChange--"><code>shouldUpdateOnChange()</code></a> is not set to <a href="../../react4j/annotations/Feature.html#DISABLE"><code>Feature.DISABLE</code></a>.</li>
+ <li><a href="../../react4j/annotations/Input.html#immutable--"><code>immutable()</code></a> ()} is not set to <code>true</code>.</li>
  <li>the view has at least one method annotated with <a href="https://arez.github.io/api/arez/annotations/Memoize.html?is-external=true" title="class or interface in arez.annotations"><code>Memoize</code></a> or <a href="https://arez.github.io/api/arez/annotations/Observe.html?is-external=true" title="class or interface in arez.annotations"><code>Observe</code></a>.</li>
  </ul></div>
 <dl>
@@ -361,7 +332,7 @@ <h4>observable</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>disposable</h4>
-<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.119">disposable</a></pre>
+<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.110">disposable</a></pre>
 <div class="block">Return an enum indicating whether the view should check whether the value of the input is disposed
  prior to rendering. If the value is disposed then the render method will exit early and return null.
  If this parameter is set to <a href="../../react4j/annotations/Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will inspect the
@@ -386,7 +357,7 @@ <h4>disposable</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>dependency</h4>
-<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.131">dependency</a></pre>
+<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.122">dependency</a></pre>
 <div class="block">Return an enum indicating whether the view should be disposed if the input is disposed. To enable this feature,
  the input MUST set <a href="../../react4j/annotations/Input.html#immutable--"><code>immutable()</code></a> to <code>true</code>, <a href="../../react4j/annotations/Input.html#disposable--"><code>disposable()</code></a> MUST resolve to
  <a href="../../react4j/annotations/Feature.html#ENABLE"><code>Feature.ENABLE</code></a>. The type of the input is expected to implement the <a href="https://arez.github.io/api/arez/component/DisposeNotifier.html?is-external=true" title="class or interface in arez.component"><code>DisposeNotifier</code></a>
@@ -412,7 +383,7 @@ <h4>dependency</h4>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>immutable</h4>
-<pre>public abstract&nbsp;boolean&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.156">immutable</a></pre>
+<pre>public abstract&nbsp;boolean&nbsp;<a href="../../src-html/react4j/annotations/Input.html#line.147">immutable</a></pre>
 <div class="block">True if the input is not expected to change after initial value is set. If the value of the input does change
  then it is expected that the view will be unmounted and a new view created. This is implemented
  by synthesizing a key for the view every time the view that is derived from this input. To enable this

api/react4j/annotations/View.Type.html

@@ -226,12 +226,11 @@ <h3>Enum Constant Detail</h3>
 <ul class="blockList">
 <li class="blockList">
 <h4>STATEFUL</h4>
-<pre>public static final&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a> <a href="../../src-html/react4j/annotations/View.Type.html#line.32">STATEFUL</a></pre>
+<pre>public static final&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a> <a href="../../src-html/react4j/annotations/View.Type.html#line.31">STATEFUL</a></pre>
 <div class="block">The view can store state in fields, can declared lifecycle methods and may contain methods annotated by
  the <a href="../../react4j/annotations/ScheduleRender.html" title="annotation in react4j.annotations"><code>ScheduleRender</code></a> annotation.
- The view will be scheduled to re-render if the views container re-renders and any inputs with
- <a href="../../react4j/annotations/Input.html#shouldUpdateOnChange--"><code>Input.shouldUpdateOnChange()</code></a> set to <code>true</code> has changed value from last render. A input
- is considered changed if when the new value and the old value are passed to
+ The view will be scheduled to re-render if the views container re-renders and any input has changed
+ value from last render. A input is considered changed when the new value and the old value are passed to
  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Objects.html?is-external=true#equals-java.lang.Object-java.lang.Object-" title="class or interface in java.util"><code>Objects.equals(Object, Object)</code></a> and that method returns <code>false</code>. A view will also
  be scheduled to re-render if the view invokes a method annotated by the <a href="../../react4j/annotations/ScheduleRender.html" title="annotation in react4j.annotations"><code>ScheduleRender</code></a> annotation.</div>
 </li>
@@ -242,7 +241,7 @@ <h4>STATEFUL</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>TRACKING</h4>
-<pre>public static final&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a> <a href="../../src-html/react4j/annotations/View.Type.html#line.37">TRACKING</a></pre>
+<pre>public static final&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a> <a href="../../src-html/react4j/annotations/View.Type.html#line.36">TRACKING</a></pre>
 <div class="block">The view is a <a href="../../react4j/annotations/View.Type.html#STATEFUL"><code>STATEFUL</code></a> view <b>and</b> will re-render the view if any Arez
  dependencies change. The framework uses the <a href="https://arez.github.io/api/arez/annotations/Observe.html?is-external=true" title="class or interface in arez.annotations"><code>Observe</code></a> annotation to track Arez dependencies.</div>
 </li>
@@ -253,7 +252,7 @@ <h4>TRACKING</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>MAYBE_TRACKING</h4>
-<pre>public static final&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a> <a href="../../src-html/react4j/annotations/View.Type.html#line.42">MAYBE_TRACKING</a></pre>
+<pre>public static final&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a> <a href="../../src-html/react4j/annotations/View.Type.html#line.41">MAYBE_TRACKING</a></pre>
 <div class="block">The view is a <a href="../../react4j/annotations/View.Type.html#TRACKING"><code>TRACKING</code></a> view but it will not generate an invariant failure if a
  render results in zero Arez dependencies.</div>
 </li>
@@ -264,7 +263,7 @@ <h4>MAYBE_TRACKING</h4>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>NO_RENDER</h4>
-<pre>public static final&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a> <a href="../../src-html/react4j/annotations/View.Type.html#line.48">NO_RENDER</a></pre>
+<pre>public static final&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a> <a href="../../src-html/react4j/annotations/View.Type.html#line.47">NO_RENDER</a></pre>
 <div class="block">The view must not have a method annotated with <a href="../../react4j/annotations/Render.html" title="annotation in react4j.annotations"><code>Render</code></a>.
  This is useful for "view" instances that provide capabilities or interact
  with services and thus need not have a render method.</div>

api/react4j/annotations/View.html

@@ -159,7 +159,7 @@ <h3>Element Detail</h3>
 <li class="blockList">
 <h4>name</h4>
 <pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
-public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../src-html/react4j/annotations/View.html#line.62">name</a></pre>
+public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../src-html/react4j/annotations/View.html#line.61">name</a></pre>
 <div class="block">Return the name of the view.
  The value defaults to the simple name name of the class. If the value is specified, the
  value must conform to the requirements of a java identifier. It should also be unique
@@ -186,7 +186,7 @@ <h4>name</h4>
 <li class="blockList">
 <h4>type</h4>
 <pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
-public abstract&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a>&nbsp;<a href="../../src-html/react4j/annotations/View.html#line.72">type</a></pre>
+public abstract&nbsp;<a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations">View.Type</a>&nbsp;<a href="../../src-html/react4j/annotations/View.html#line.71">type</a></pre>
 <div class="block">Enum indicating the capabilities of the view.
  See the <a href="../../react4j/annotations/View.Type.html" title="enum in react4j.annotations"><code>View.Type</code></a> enum for further details.</div>
 <dl>
@@ -210,7 +210,7 @@ <h4>type</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>inject</h4>
-<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/View.html#line.85">inject</a></pre>
+<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/View.html#line.84">inject</a></pre>
 <div class="block">Enum controlling whether javax.inject integration is generated for the view.
  The generated class is the same name as the view with the "Factory" suffix.
  React4j only supports constructor injection and thus this MUST NOT be set to <a href="../../react4j/annotations/Feature.html#ENABLE"><code>Feature.ENABLE</code></a>
@@ -237,7 +237,7 @@ <h4>inject</h4>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>sting</h4>
-<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/View.html#line.98">sting</a></pre>
+<pre>public abstract&nbsp;<a href="../../react4j/annotations/Feature.html" title="enum in react4j.annotations">Feature</a>&nbsp;<a href="../../src-html/react4j/annotations/View.html#line.97">sting</a></pre>
 <div class="block">Enum controlling whether Sting injection integration is generated for the view.
  The generated class is the same name as the view with the "Factory" suffix.
  React4j only supports constructor injection and thus this MUST NOT be set to <a href="../../react4j/annotations/Feature.html#ENABLE"><code>Feature.ENABLE</code></a>