Skip to content

Commit df1e511

Browse files
realityforgerealityforge
committed
Publish website
1 parent fd7aae5 commit df1e511

10 files changed

Lines changed: 2061 additions & 1902 deletions

File tree

‎api-diff/data/react4j/0.209-0.210.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[
2+
{
3+
"code": "java.annotation.attributeValueChanged",
4+
"description": "Attribute 'value' of annotation 'java.lang.annotation.Target' changed value from '{java.lang.annotation.ElementType.METHOD}' to '{java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.PARAMETER}'.",
5+
"element": "@interface react4j.annotations.Input",
6+
"classification": {
7+
"SOURCE": "EQUIVALENT",
8+
"BINARY": "EQUIVALENT",
9+
"SEMANTIC": "POTENTIALLY_BREAKING"
10+
},
11+
"attachments": {
12+
"annotation": "@java.lang.annotation.Target({java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.PARAMETER})",
13+
"annotationType": "java.lang.annotation.Target",
14+
"attribute": "value",
15+
"classQualifiedName": "react4j.annotations.Input",
16+
"classSimpleName": "Input",
17+
"elementKind": "@interface",
18+
"newValue": "{java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.PARAMETER}",
19+
"oldValue": "{java.lang.annotation.ElementType.METHOD}",
20+
"package": "react4j.annotations"
21+
}
22+
}
23+
]

‎api/allclasses-index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
165165
</div>
166166
<div class="col-first odd-row-color all-classes-table all-classes-table-tab7"><a href="react4j/annotations/Input.html" title="annotation interface in react4j.annotations">Input</a></div>
167167
<div class="col-last odd-row-color all-classes-table all-classes-table-tab7">
168-
<div class="block">Annotation used to specify an abstract method that returns a prop.</div>
168+
<div class="block">Annotation used to specify an input.</div>
169169
</div>
170170
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="react4j/annotations/Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></div>
171171
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">

‎api/index-all.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2636,7 +2636,7 @@ <h2 class="title" id="I:I">I</h2>
26362636
<dd>&nbsp;</dd>
26372637
<dt><a href="react4j/annotations/Input.html" class="type-name-link" title="annotation interface in react4j.annotations">Input</a> - Annotation Interface in <a href="react4j/annotations/package-summary.html">react4j.annotations</a></dt>
26382638
<dd>
2639-
<div class="block">Annotation used to specify an abstract method that returns a prop.</div>
2639+
<div class="block">Annotation used to specify an input.</div>
26402640
</dd>
26412641
<dt><a href="react4j/annotations/Input.Source.html" class="type-name-link" title="enum class in react4j.annotations">Input.Source</a> - Enum Class in <a href="react4j/annotations/package-summary.html">react4j.annotations</a></dt>
26422642
<dd>

‎api/react4j/annotations/Input.Source.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h1 title="Enum Class Input.Source" class="title">Enum Class Input.Source</h1>
8585
<dd><a href="Input.html" title="annotation interface in react4j.annotations">Input</a></dd>
8686
</dl>
8787
<hr>
88-
<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-176">Input.Source</a></span>
88+
<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-179">Input.Source</a></span>
8989
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>&gt;</span></div>
9090
<div class="block">Enum where the input is sourced from.</div>
9191
</section>
@@ -164,14 +164,14 @@ <h2>Enum Constant Details</h2>
164164
<li>
165165
<section class="detail" id="DEFAULT">
166166
<h3>DEFAULT</h3>
167-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-181">DEFAULT</a></span></div>
167+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-184">DEFAULT</a></span></div>
168168
<div class="block">The input value is passed to the view during construction.</div>
169169
</section>
170170
</li>
171171
<li>
172172
<section class="detail" id="CONTEXT">
173173
<h3>CONTEXT</h3>
174-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-185">CONTEXT</a></span></div>
174+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-188">CONTEXT</a></span></div>
175175
<div class="block">The input value is retrieved from the react context.</div>
176176
</section>
177177
</li>
@@ -186,7 +186,7 @@ <h2>Method Details</h2>
186186
<li>
187187
<section class="detail" id="values()">
188188
<h3>values</h3>
189-
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-176">values</a></span>()</div>
189+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-179">values</a></span>()</div>
190190
<div class="block">Returns an array containing the constants of this enum class, in
191191
the order they are declared.</div>
192192
<dl class="notes">
@@ -198,7 +198,7 @@ <h3>values</h3>
198198
<li>
199199
<section class="detail" id="valueOf(java.lang.String)">
200200
<h3>valueOf</h3>
201-
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-176">valueOf</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
201+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.Source.html#line-179">valueOf</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
202202
<div class="block">Returns the enum constant of this class with the specified name.
203203
The string must match <i>exactly</i> an identifier used to declare an
204204
enum constant in this class. (Extraneous whitespace characters are

‎api/react4j/annotations/Input.html‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,16 @@ <h1 title="Annotation Interface Input" class="title">Annotation Interface Input<
6767
<section class="class-description" id="class-description">
6868
<hr>
6969
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
70-
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>)
71-
</span><span class="modifiers">public @interface </span><span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-46">Input</a></span></div>
72-
<div class="block">Annotation used to specify an abstract method that returns a prop.
73-
The property is extracted from Reacts underlying props object. By default the prop is passed as
74-
a value in when creating the view but it can also be retrieved from the react context.
70+
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>({<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>,<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#PARAMETER" title="class or interface in java.lang.annotation" class="external-link">PARAMETER</a>})
71+
</span><span class="modifiers">public @interface </span><span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-49">Input</a></span></div>
72+
<div class="block">Annotation used to specify an input.
73+
The property is extracted from Reacts underlying props object. By default the input is passed as a
74+
value in when creating the view but it can also be retrieved from the react context.
75+
When applied to an abstract method, the input can be mutable or immutable.
76+
When applied to a constructor parameter, the input must set <a href="#immutable()"><code>immutable()</code></a> to <code>true</code>.
7577

76-
<p>The method that is annotated with this annotation must also comply with the following constraints:</p>
78+
<p>If applied to a method, the method that is annotated with this annotation must also comply with the
79+
following constraints:</p>
7780
<ul>
7881
<li>Must not be annotated with any other react annotation</li>
7982
<li>Must have 0 parameters</li>
@@ -190,7 +193,7 @@ <h2>Element Details</h2>
190193
<section class="detail" id="name()">
191194
<h3>name</h3>
192195
<div class="member-signature"><span class="annotations">@Nonnull
193-
</span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-57">name</a></span></div>
196+
</span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-60">name</a></span></div>
194197
<div class="block">Return the name of the input.
195198
The name is the key used when accessing the input from the inputs object. It is also used when creating
196199
the builder steps associated with the inputs that set <a href="#source()"><code>source()</code></a> to <a href="Input.Source.html#DEFAULT"><code>Input.Source.DEFAULT</code></a>.</div>
@@ -208,7 +211,7 @@ <h3>name</h3>
208211
<section class="detail" id="qualifier()">
209212
<h3>qualifier</h3>
210213
<div class="member-signature"><span class="annotations">@Nonnull
211-
</span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-66">qualifier</a></span></div>
214+
</span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-69">qualifier</a></span></div>
212215
<div class="block">Return the qualifier used to access value from context.
213216
It must only be specified if <a href="#source()"><code>source()</code></a> is set to <a href="Input.Source.html#CONTEXT"><code>Input.Source.CONTEXT</code></a>.</div>
214217
<dl class="notes">
@@ -224,7 +227,7 @@ <h3>qualifier</h3>
224227
<li>
225228
<section class="detail" id="source()">
226229
<h3>source</h3>
227-
<div class="member-signature"><span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-77">source</a></span></div>
230+
<div class="member-signature"><span class="return-type"><a href="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-80">source</a></span></div>
228231
<div class="block">The setting controlling where the input value is source from.
229232
If the source is set to <a href="Input.Source.html#CONTEXT"><code>Input.Source.CONTEXT</code></a> then the input is sometimes described as a "TreeInput"
230233
as it is transparently passed from a parent view to all child views. A "TreeInput" does not
@@ -242,7 +245,7 @@ <h3>source</h3>
242245
<li>
243246
<section class="detail" id="require()">
244247
<h3>require</h3>
245-
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-91">require</a></span></div>
248+
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-94">require</a></span></div>
246249
<div class="block">Setting indicating whether the input should be supplied when the view is constructed.
247250
This influences validation when enabled and how the Builder class is created.
248251
If set to <a href="Feature.html#ENABLE"><code>Feature.ENABLE</code></a> then the user MUST supply the input and the builder will require the user
@@ -264,7 +267,7 @@ <h3>require</h3>
264267
<li>
265268
<section class="detail" id="observable()">
266269
<h3>observable</h3>
267-
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-104">observable</a></span></div>
270+
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-107">observable</a></span></div>
268271
<div class="block">Indicate whether the input should be annotated by <a href="https://arez.github.io/api/arez/annotations/Observable.html" title="class or interface in arez.annotations" class="external-link"><code>Observable</code></a>.
269272

270273
<p>If set to <a href="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the input will be observable if and only if:</p>
@@ -285,7 +288,7 @@ <h3>observable</h3>
285288
<li>
286289
<section class="detail" id="disposable()">
287290
<h3>disposable</h3>
288-
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-115">disposable</a></span></div>
291+
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-118">disposable</a></span></div>
289292
<div class="block">Return an enum indicating whether the view should check whether the value of the input is disposed
290293
prior to rendering. If the value is disposed then the render method will exit early and return null.
291294
If this parameter is set to <a href="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will inspect the
@@ -304,7 +307,7 @@ <h3>disposable</h3>
304307
<li>
305308
<section class="detail" id="observeOnRender()">
306309
<h3>observeOnRender</h3>
307-
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-134">observeOnRender</a></span></div>
310+
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-137">observeOnRender</a></span></div>
308311
<div class="block">Return an enum indicating whether tracked renders should observe the input value during the generated render
309312
prelude so that disposing the input can invalidate the render and trigger a rerender.
310313
This parameter is independent of <a href="#disposable()"><code>disposable()</code></a> and is only relevant to views with render tracking enabled.
@@ -331,7 +334,7 @@ <h3>observeOnRender</h3>
331334
<li>
332335
<section class="detail" id="dependency()">
333336
<h3>dependency</h3>
334-
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-146">dependency</a></span></div>
337+
<div class="member-signature"><span class="return-type"><a href="Feature.html" title="enum class in react4j.annotations">Feature</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-149">dependency</a></span></div>
335338
<div class="block">Return an enum indicating whether the view should be disposed if the input is disposed. To enable this feature,
336339
the input MUST set <a href="#immutable()"><code>immutable()</code></a> to <code>true</code>, <a href="#disposable()"><code>disposable()</code></a> MUST resolve to
337340
<a href="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" title="class or interface in arez.component" class="external-link"><code>DisposeNotifier</code></a>
@@ -351,7 +354,7 @@ <h3>dependency</h3>
351354
<li>
352355
<section class="detail" id="immutable()">
353356
<h3>immutable</h3>
354-
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-171">immutable</a></span></div>
357+
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-174">immutable</a></span></div>
355358
<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
356359
then it is expected that the view will be unmounted and a new view created. This is implemented
357360
by synthesizing a key for the view every time the view that is derived from this input. To enable this

0 commit comments

Comments
 (0)