Skip to content

Commit f587f71

Browse files
committed
Publish website
1 parent 0cfe473 commit f587f71

14 files changed

Lines changed: 1186 additions & 1141 deletions

File tree

api/allclasses-index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
343343
</div>
344344
<div class="col-first even-row-color all-classes-table all-classes-table-tab7"><a href="react4j/annotations/Render.html" title="annotation interface in react4j.annotations">Render</a></div>
345345
<div class="col-last even-row-color all-classes-table all-classes-table-tab7">
346-
<div class="block">Identifies the method that is invoked to render the view.</div>
346+
<div class="block">Identifies the method invoked to render the view.</div>
347347
</div>
348348
<div class="col-first odd-row-color all-classes-table all-classes-table-tab7"><a href="react4j/annotations/ScheduleRender.html" title="annotation interface in react4j.annotations">ScheduleRender</a></div>
349349
<div class="col-last odd-row-color all-classes-table all-classes-table-tab7">

api/index-all.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4550,7 +4550,7 @@ <h2 class="title" id="I:R">R</h2>
45504550
</dd>
45514551
<dt><a href="react4j/annotations/Render.html" class="type-name-link" title="annotation interface in react4j.annotations">Render</a> - Annotation Interface in <a href="react4j/annotations/package-summary.html">react4j.annotations</a></dt>
45524552
<dd>
4553-
<div class="block">Identifies the method that is invoked to render the view.</div>
4553+
<div class="block">Identifies the method invoked to render the view.</div>
45544554
</dd>
45554555
<dt><a href="react4j/annotations/Input.html#require()" class="member-name-link">require()</a> - Element in annotation interface react4j.annotations.<a href="react4j/annotations/Input.html" title="annotation interface in react4j.annotations">Input</a></dt>
45564556
<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-152">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-157">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-157">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-162">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-161">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-166">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-152">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-157">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-152">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-157">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: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ <h1 title="Annotation Interface Input" class="title">Annotation Interface Input<
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>
7070
<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-41">Input</a></span></div>
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>
7272
<div class="block">Annotation used to specify an abstract method that returns a prop.
7373
The property is extracted from Reacts underlying props object. By default the prop is passed as
7474
a value in when creating the view but it can also be retrieved from the react context.
@@ -92,6 +92,11 @@ <h1 title="Annotation Interface Input" class="title">Annotation Interface Input<
9292
expected to be invoked outside the view. A warning will be generated but can be suppressed by the
9393
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/SuppressWarnings.html" title="class or interface in java.lang" class="external-link"><code>SuppressWarnings</code></a> or <a href="SuppressReact4jWarnings.html" title="annotation interface in react4j.annotations"><code>SuppressReact4jWarnings</code></a> annotations with a key "React4j:ProtectedMethod".
9494
</li>
95+
<li>
96+
Should be annotated with either <code>Nonnull</code> or <code>Nullable</code> if the
97+
return type is not a primitive. A warning will be generated but can be suppressed by the <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/SuppressWarnings.html" title="class or interface in java.lang" class="external-link"><code>SuppressWarnings</code></a>
98+
or <a href="SuppressReact4jWarnings.html" title="annotation interface in react4j.annotations"><code>SuppressReact4jWarnings</code></a> annotations with a key "React4j:MissingInputNullability".
99+
</li>
95100
</ul></div>
96101
</section>
97102
<section class="summary">
@@ -179,7 +184,7 @@ <h2>Element Details</h2>
179184
<section class="detail" id="name()">
180185
<h3>name</h3>
181186
<div class="member-signature"><span class="annotations">@Nonnull
182-
</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-52">name</a></span></div>
187+
</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>
183188
<div class="block">Return the name of the input.
184189
The name is the key used when accessing the input from the inputs object. It is also used when creating
185190
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>
@@ -197,7 +202,7 @@ <h3>name</h3>
197202
<section class="detail" id="qualifier()">
198203
<h3>qualifier</h3>
199204
<div class="member-signature"><span class="annotations">@Nonnull
200-
</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-61">qualifier</a></span></div>
205+
</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>
201206
<div class="block">Return the qualifier used to access value from context.
202207
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>
203208
<dl class="notes">
@@ -213,7 +218,7 @@ <h3>qualifier</h3>
213218
<li>
214219
<section class="detail" id="source()">
215220
<h3>source</h3>
216-
<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-72">source</a></span></div>
221+
<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>
217222
<div class="block">The setting controlling where the input value is source from.
218223
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"
219224
as it is transparently passed from a parent view to all child views. A "TreeInput" does not
@@ -231,7 +236,7 @@ <h3>source</h3>
231236
<li>
232237
<section class="detail" id="require()">
233238
<h3>require</h3>
234-
<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-86">require</a></span></div>
239+
<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>
235240
<div class="block">Setting indicating whether the input should be supplied when the view is constructed.
236241
This influences validation when enabled and how the Builder class is created.
237242
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
@@ -253,7 +258,7 @@ <h3>require</h3>
253258
<li>
254259
<section class="detail" id="observable()">
255260
<h3>observable</h3>
256-
<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-99">observable</a></span></div>
261+
<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>
257262
<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>.
258263

259264
<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>
@@ -274,7 +279,7 @@ <h3>observable</h3>
274279
<li>
275280
<section class="detail" id="disposable()">
276281
<h3>disposable</h3>
277-
<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-110">disposable</a></span></div>
282+
<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>
278283
<div class="block">Return an enum indicating whether the view should check whether the value of the input is disposed
279284
prior to rendering. If the value is disposed then the render method will exit early and return null.
280285
If this parameter is set to <a href="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will inspect the
@@ -293,7 +298,7 @@ <h3>disposable</h3>
293298
<li>
294299
<section class="detail" id="dependency()">
295300
<h3>dependency</h3>
296-
<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-122">dependency</a></span></div>
301+
<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-127">dependency</a></span></div>
297302
<div class="block">Return an enum indicating whether the view should be disposed if the input is disposed. To enable this feature,
298303
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
299304
<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>
@@ -313,7 +318,7 @@ <h3>dependency</h3>
313318
<li>
314319
<section class="detail" id="immutable()">
315320
<h3>immutable</h3>
316-
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-147">immutable</a></span></div>
321+
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-152">immutable</a></span></div>
317322
<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
318323
then it is expected that the view will be unmounted and a new view created. This is implemented
319324
by synthesizing a key for the view every time the view that is derived from this input. To enable this

api/react4j/annotations/Render.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ <h1 title="Annotation Interface Render" class="title">Annotation Interface Rende
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>
7070
<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/Render.html#line-33">Render</a></span></div>
72-
<div class="block">Identifies the method that is invoked to render the view.
71+
</span><span class="modifiers">public @interface </span><span class="element-name"><a href="../../src-html/react4j/annotations/Render.html#line-38">Render</a></span></div>
72+
<div class="block">Identifies the method invoked to render the view.
7373
There must be exactly one method annotated with this annotation within the view.
7474
The method must return a value of type <a href="../ReactNode.html" title="interface in react4j"><code>ReactNode</code></a>.
7575

@@ -92,6 +92,11 @@ <h1 title="Annotation Interface Render" class="title">Annotation Interface Rende
9292
expected to be invoked outside the view. A warning will be generated but can be suppressed by the
9393
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/SuppressWarnings.html" title="class or interface in java.lang" class="external-link"><code>SuppressWarnings</code></a> or <a href="SuppressReact4jWarnings.html" title="annotation interface in react4j.annotations"><code>SuppressReact4jWarnings</code></a> annotations with a key "React4j:ProtectedMethod".
9494
</li>
95+
<li>
96+
Should be annotated with either <code>Nonnull</code> or <code>Nullable</code>. If neither
97+
annoation is present then a warning will be generated but can be suppressed by the <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/SuppressWarnings.html" title="class or interface in java.lang" class="external-link"><code>SuppressWarnings</code></a> or
98+
<a href="SuppressReact4jWarnings.html" title="annotation interface in react4j.annotations"><code>SuppressReact4jWarnings</code></a> annotations with a key "React4j:MissingRenderNullability".
99+
</li>
95100
</ul></div>
96101
</section>
97102
<!-- ========= END OF CLASS DATA ========= -->

0 commit comments

Comments
 (0)