You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<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>
4552
4552
<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>
4554
4554
</dd>
4555
4555
<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>
<spanclass="extends-implements">extends <ahref="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><<ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>></span></div>
90
90
<divclass="block">Enum where the input is sourced from.</div>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-157">DEFAULT</a></span></div>
167
+
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-162">DEFAULT</a></span></div>
168
168
<divclass="block">The input value is passed to the view during construction.</div>
169
169
</section>
170
170
</li>
171
171
<li>
172
172
<sectionclass="detail" id="CONTEXT">
173
173
<h3>CONTEXT</h3>
174
-
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-161">CONTEXT</a></span></div>
174
+
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-166">CONTEXT</a></span></div>
175
175
<divclass="block">The input value is retrieved from the react context.</div>
176
176
</section>
177
177
</li>
@@ -186,7 +186,7 @@ <h2>Method Details</h2>
186
186
<li>
187
187
<sectionclass="detail" id="values()">
188
188
<h3>values</h3>
189
-
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-152">values</a></span>()</div>
189
+
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a>[]</span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-157">values</a></span>()</div>
190
190
<divclass="block">Returns an array containing the constants of this enum class, in
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-152">valueOf</a></span><wbr><spanclass="parameters">(<ahref="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> name)</span></div>
201
+
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.Source.html#line-157">valueOf</a></span><wbr><spanclass="parameters">(<ahref="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> name)</span></div>
202
202
<divclass="block">Returns the enum constant of this class with the specified name.
203
203
The string must match <i>exactly</i> an identifier used to declare an
204
204
enum constant in this class. (Extraneous whitespace characters are
<divclass="type-signature"><spanclass="annotations"><ahref="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
70
<ahref="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>(<ahref="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>)
expected to be invoked outside the view. A warning will be generated but can be suppressed by the
93
93
<ahref="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 <ahref="SuppressReact4jWarnings.html" title="annotation interface in react4j.annotations"><code>SuppressReact4jWarnings</code></a> annotations with a key "React4j:ProtectedMethod".
94
94
</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 <ahref="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 <ahref="SuppressReact4jWarnings.html" title="annotation interface in react4j.annotations"><code>SuppressReact4jWarnings</code></a> annotations with a key "React4j:MissingInputNullability".
</span><spanclass="return-type"><ahref="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> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-52">name</a></span></div>
187
+
</span><spanclass="return-type"><ahref="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> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-57">name</a></span></div>
183
188
<divclass="block">Return the name of the input.
184
189
The name is the key used when accessing the input from the inputs object. It is also used when creating
185
190
the builder steps associated with the inputs that set <ahref="#source()"><code>source()</code></a> to <ahref="Input.Source.html#DEFAULT"><code>Input.Source.DEFAULT</code></a>.</div>
</span><spanclass="return-type"><ahref="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> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-61">qualifier</a></span></div>
205
+
</span><spanclass="return-type"><ahref="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> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-66">qualifier</a></span></div>
201
206
<divclass="block">Return the qualifier used to access value from context.
202
207
It must only be specified if <ahref="#source()"><code>source()</code></a> is set to <ahref="Input.Source.html#CONTEXT"><code>Input.Source.CONTEXT</code></a>.</div>
203
208
<dlclass="notes">
@@ -213,7 +218,7 @@ <h3>qualifier</h3>
213
218
<li>
214
219
<sectionclass="detail" id="source()">
215
220
<h3>source</h3>
216
-
<divclass="member-signature"><spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-72">source</a></span></div>
221
+
<divclass="member-signature"><spanclass="return-type"><ahref="Input.Source.html" title="enum class in react4j.annotations">Input.Source</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-77">source</a></span></div>
217
222
<divclass="block">The setting controlling where the input value is source from.
218
223
If the source is set to <ahref="Input.Source.html#CONTEXT"><code>Input.Source.CONTEXT</code></a> then the input is sometimes described as a "TreeInput"
219
224
as it is transparently passed from a parent view to all child views. A "TreeInput" does not
@@ -231,7 +236,7 @@ <h3>source</h3>
231
236
<li>
232
237
<sectionclass="detail" id="require()">
233
238
<h3>require</h3>
234
-
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-86">require</a></span></div>
239
+
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-91">require</a></span></div>
235
240
<divclass="block">Setting indicating whether the input should be supplied when the view is constructed.
236
241
This influences validation when enabled and how the Builder class is created.
237
242
If set to <ahref="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>
253
258
<li>
254
259
<sectionclass="detail" id="observable()">
255
260
<h3>observable</h3>
256
-
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-99">observable</a></span></div>
261
+
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-104">observable</a></span></div>
257
262
<divclass="block">Indicate whether the input should be annotated by <ahref="https://arez.github.io/api/arez/annotations/Observable.html" title="class or interface in arez.annotations" class="external-link"><code>Observable</code></a>.
258
263
259
264
<p>If set to <ahref="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>
274
279
<li>
275
280
<sectionclass="detail" id="disposable()">
276
281
<h3>disposable</h3>
277
-
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-110">disposable</a></span></div>
282
+
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-115">disposable</a></span></div>
278
283
<divclass="block">Return an enum indicating whether the view should check whether the value of the input is disposed
279
284
prior to rendering. If the value is disposed then the render method will exit early and return null.
280
285
If this parameter is set to <ahref="Feature.html#AUTODETECT"><code>Feature.AUTODETECT</code></a> then the annotation processor will inspect the
@@ -293,7 +298,7 @@ <h3>disposable</h3>
293
298
<li>
294
299
<sectionclass="detail" id="dependency()">
295
300
<h3>dependency</h3>
296
-
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-122">dependency</a></span></div>
301
+
<divclass="member-signature"><spanclass="return-type"><ahref="Feature.html" title="enum class in react4j.annotations">Feature</a></span> <spanclass="element-name"><ahref="../../src-html/react4j/annotations/Input.html#line-127">dependency</a></span></div>
297
302
<divclass="block">Return an enum indicating whether the view should be disposed if the input is disposed. To enable this feature,
298
303
the input MUST set <ahref="#immutable()"><code>immutable()</code></a> to <code>true</code>, <ahref="#disposable()"><code>disposable()</code></a> MUST resolve to
299
304
<ahref="Feature.html#ENABLE"><code>Feature.ENABLE</code></a>. The type of the input is expected to implement the <ahref="https://arez.github.io/api/arez/component/DisposeNotifier.html" title="class or interface in arez.component" class="external-link"><code>DisposeNotifier</code></a>
<divclass="type-signature"><spanclass="annotations"><ahref="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
70
<ahref="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>(<ahref="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>)
expected to be invoked outside the view. A warning will be generated but can be suppressed by the
93
93
<ahref="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 <ahref="SuppressReact4jWarnings.html" title="annotation interface in react4j.annotations"><code>SuppressReact4jWarnings</code></a> annotations with a key "React4j:ProtectedMethod".
94
94
</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 <ahref="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
+
<ahref="SuppressReact4jWarnings.html" title="annotation interface in react4j.annotations"><code>SuppressReact4jWarnings</code></a> annotations with a key "React4j:MissingRenderNullability".
0 commit comments