Skip to content

Commit 15fe53c

Browse files
committed
Publish website
1 parent b6d7859 commit 15fe53c

11 files changed

Lines changed: 2033 additions & 1892 deletions

File tree

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
[
2+
{
3+
"code": "java.annotation.added",
4+
"description": "Element newly annotated with 'react4j.annotations.ActAsStingConsumer'.",
5+
"element": "@interface react4j.annotations.View",
6+
"classification": {
7+
"SOURCE": "EQUIVALENT",
8+
"BINARY": "EQUIVALENT",
9+
"SEMANTIC": "POTENTIALLY_BREAKING"
10+
},
11+
"attachments": {
12+
"annotation": "@react4j.annotations.ActAsStingConsumer",
13+
"annotationType": "react4j.annotations.ActAsStingConsumer",
14+
"classQualifiedName": "react4j.annotations.View",
15+
"classSimpleName": "View",
16+
"elementKind": "@interface",
17+
"package": "react4j.annotations"
18+
}
19+
},
20+
{
21+
"code": "java.annotation.added",
22+
"description": "Element newly annotated with 'react4j.annotations.StingProvider'.",
23+
"element": "@interface react4j.annotations.View",
24+
"classification": {
25+
"SOURCE": "EQUIVALENT",
26+
"BINARY": "EQUIVALENT",
27+
"SEMANTIC": "POTENTIALLY_BREAKING"
28+
},
29+
"attachments": {
30+
"annotation": "@react4j.annotations.StingProvider(\"[FlatEnclosingName]React4j_[SimpleName]Factory\")",
31+
"annotationType": "react4j.annotations.StingProvider",
32+
"classQualifiedName": "react4j.annotations.View",
33+
"classSimpleName": "View",
34+
"elementKind": "@interface",
35+
"package": "react4j.annotations"
36+
}
37+
},
38+
{
39+
"code": "java.annotation.removed",
40+
"description": "Element no longer annotated with 'react4j.annotations.ActAsStingComponent'.",
41+
"element": "@interface react4j.annotations.View",
42+
"classification": {
43+
"SOURCE": "EQUIVALENT",
44+
"BINARY": "EQUIVALENT",
45+
"SEMANTIC": "POTENTIALLY_BREAKING"
46+
},
47+
"attachments": {
48+
"annotation": "@react4j.annotations.ActAsStingComponent",
49+
"annotationType": "react4j.annotations.ActAsStingComponent",
50+
"classQualifiedName": "react4j.annotations.View",
51+
"classSimpleName": "View",
52+
"elementKind": "@interface",
53+
"package": "react4j.annotations"
54+
}
55+
},
56+
{
57+
"code": "java.method.attributeWithDefaultAddedToAnnotationType",
58+
"description": "The annotation has a new attribute with a default value.",
59+
"newElement": "method boolean react4j.annotations.View::exportBuilder()",
60+
"classification": {
61+
"SOURCE": "NON_BREAKING",
62+
"BINARY": "NON_BREAKING"
63+
},
64+
"attachments": {
65+
"classQualifiedName": "react4j.annotations.View",
66+
"classSimpleName": "View",
67+
"elementKind": "method",
68+
"methodName": "exportBuilder",
69+
"package": "react4j.annotations"
70+
}
71+
}
72+
]

api/index-all.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -982,6 +982,10 @@ <h2 class="title" id="I:E">E</h2>
982982
<dd>
983983
<div class="block">Set the `react4j.enable_view_names` setting to <code>true</code>.</div>
984984
</dd>
985+
<dt><a href="react4j/annotations/View.html#exportBuilder()" class="member-name-link">exportBuilder()</a> - Element in annotation interface react4j.annotations.<a href="react4j/annotations/View.html" title="annotation interface in react4j.annotations">View</a></dt>
986+
<dd>
987+
<div class="block">Return true if the generated builder API should be public.</div>
988+
</dd>
985989
</dl>
986990
<h2 class="title" id="I:F">F</h2>
987991
<dl class="index">

api/member-search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

api/react4j/annotations/Input.html

Lines changed: 6 additions & 6 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>,<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-47">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-45">Input</a></span></div>
7272
<div class="block">Annotation used to specify an input.
7373
The property is extracted from Reacts underlying props object. By default the input is passed as a
7474
value in when creating the view but it can also be retrieved from the react context.
@@ -155,7 +155,7 @@ <h2>Element Details</h2>
155155
<section class="detail" id="name()">
156156
<h3>name</h3>
157157
<div class="member-signature"><span class="annotations">@Nonnull
158-
</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-58">name</a></span></div>
158+
</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-56">name</a></span></div>
159159
<div class="block">Return the name of the input.
160160
The name is the key used when accessing the input from the inputs object. It is also used when creating
161161
the builder steps associated with inputs that are not sourced from tree context.</div>
@@ -173,7 +173,7 @@ <h3>name</h3>
173173
<section class="detail" id="qualifier()">
174174
<h3>qualifier</h3>
175175
<div class="member-signature"><span class="annotations">@Nonnull
176-
</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-67">qualifier</a></span></div>
176+
</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-65">qualifier</a></span></div>
177177
<div class="block">Return the qualifier used to access value from context.
178178
It must only be specified if <a href="#fromTreeContext()"><code>fromTreeContext()</code></a> is set to <code>true</code>.</div>
179179
<dl class="notes">
@@ -189,7 +189,7 @@ <h3>qualifier</h3>
189189
<li>
190190
<section class="detail" id="fromTreeContext()">
191191
<h3>fromTreeContext</h3>
192-
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-77">fromTreeContext</a></span></div>
192+
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/Input.html#line-75">fromTreeContext</a></span></div>
193193
<div class="block">Return <code>true</code> if the input value should be sourced from tree context rather than supplied when
194194
creating the view. Inputs sourced from tree context are transparently passed from a parent view to
195195
descendant views and do not need to be specified by the user when creating the view.</div>
@@ -206,7 +206,7 @@ <h3>fromTreeContext</h3>
206206
<li>
207207
<section class="detail" id="require()">
208208
<h3>require</h3>
209-
<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>
209+
<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-89">require</a></span></div>
210210
<div class="block">Setting indicating whether the input should be supplied when the view is constructed.
211211
This influences validation when enabled and how the Builder class is created.
212212
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
@@ -228,7 +228,7 @@ <h3>require</h3>
228228
<li>
229229
<section class="detail" id="observable()">
230230
<h3>observable</h3>
231-
<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>
231+
<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-102">observable</a></span></div>
232232
<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>.
233233

234234
<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>

api/react4j/annotations/View.Type.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h1 title="Enum Class View.Type" class="title">Enum Class View.Type</h1>
8585
<dd><a href="View.html" title="annotation interface in react4j.annotations">View</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/View.html#line-22">View.Type</a></span>
88+
<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name"><a href="../../src-html/react4j/annotations/View.html#line-23">View.Type</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="View.Type.html" title="enum class in react4j.annotations">View.Type</a>&gt;</span></div>
9090
<div class="block">Enum indicating type of view.</div>
9191
</section>
@@ -175,7 +175,7 @@ <h2>Enum Constant Details</h2>
175175
<li>
176176
<section class="detail" id="STATEFUL">
177177
<h3>STATEFUL</h3>
178-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-32">STATEFUL</a></span></div>
178+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-33">STATEFUL</a></span></div>
179179
<div class="block">The view can store state in fields, can declared lifecycle methods and may contain methods annotated by
180180
the <a href="ScheduleRender.html" title="annotation interface in react4j.annotations"><code>ScheduleRender</code></a> annotation.
181181
The view will be scheduled to re-render if the views container re-renders and any input has changed
@@ -187,23 +187,23 @@ <h3>STATEFUL</h3>
187187
<li>
188188
<section class="detail" id="TRACKING">
189189
<h3>TRACKING</h3>
190-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-37">TRACKING</a></span></div>
190+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-38">TRACKING</a></span></div>
191191
<div class="block">The view is a <a href="#STATEFUL"><code>STATEFUL</code></a> view <b>and</b> will re-render the view if any Arez
192192
dependencies change. The framework uses the <a href="https://arez.github.io/api/arez/annotations/Observe.html" title="class or interface in arez.annotations" class="external-link"><code>Observe</code></a> annotation to track Arez dependencies.</div>
193193
</section>
194194
</li>
195195
<li>
196196
<section class="detail" id="MAYBE_TRACKING">
197197
<h3>MAYBE_TRACKING</h3>
198-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-42">MAYBE_TRACKING</a></span></div>
198+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-43">MAYBE_TRACKING</a></span></div>
199199
<div class="block">The view is a <a href="#TRACKING"><code>TRACKING</code></a> view but it will not generate an invariant failure if a
200200
render results in zero Arez dependencies.</div>
201201
</section>
202202
</li>
203203
<li>
204204
<section class="detail" id="NO_RENDER">
205205
<h3>NO_RENDER</h3>
206-
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-48">NO_RENDER</a></span></div>
206+
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-49">NO_RENDER</a></span></div>
207207
<div class="block">The view must not have a method annotated with <a href="Render.html" title="annotation interface in react4j.annotations"><code>Render</code></a>.
208208
This is useful for "view" instances that provide capabilities or interact
209209
with services and thus need not have a render method.</div>
@@ -220,7 +220,7 @@ <h2>Method Details</h2>
220220
<li>
221221
<section class="detail" id="values()">
222222
<h3>values</h3>
223-
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a>[]</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-22">values</a></span>()</div>
223+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a>[]</span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-23">values</a></span>()</div>
224224
<div class="block">Returns an array containing the constants of this enum class, in
225225
the order they are declared.</div>
226226
<dl class="notes">
@@ -232,7 +232,7 @@ <h3>values</h3>
232232
<li>
233233
<section class="detail" id="valueOf(java.lang.String)">
234234
<h3>valueOf</h3>
235-
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-22">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>
235+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="View.Type.html" title="enum class in react4j.annotations">View.Type</a></span>&nbsp;<span class="element-name"><a href="../../src-html/react4j/annotations/View.Type.html#line-23">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>
236236
<div class="block">Returns the enum constant of this class with the specified name.
237237
The string must match <i>exactly</i> an identifier used to declare an
238238
enum constant in this class. (Extraneous whitespace characters are

0 commit comments

Comments
 (0)