Skip to content

Commit 2ffd632

Browse files
committed
Publishing docs for component persist
1 parent f11b43c commit 2ffd632

File tree

5 files changed

+423
-374
lines changed

5 files changed

+423
-374
lines changed

persist/arez/persist/Persist.html

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,13 @@ <h2>Optional Element Summary</h2>
8888
<div class="block">Return the name used to persist the property.</div>
8989
</div>
9090
<div class="col-first odd-row-color"><code><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></code></div>
91-
<div class="col-second odd-row-color"><code><a href="#store()" class="member-name-link">store</a></code></div>
91+
<div class="col-second odd-row-color"><code><a href="#setterName()" class="member-name-link">setterName</a></code></div>
9292
<div class="col-last odd-row-color">
93+
<div class="block">Return the name of the setter.</div>
94+
</div>
95+
<div class="col-first even-row-color"><code><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></code></div>
96+
<div class="col-second even-row-color"><code><a href="#store()" class="member-name-link">store</a></code></div>
97+
<div class="col-last even-row-color">
9398
<div class="block">The key identifying the store where the observable data is stored.</div>
9499
</div>
95100
</div>
@@ -142,6 +147,24 @@ <h3>store</h3>
142147
</dl>
143148
</section>
144149
</li>
150+
<li>
151+
<section class="detail" id="setterName()">
152+
<h3>setterName</h3>
153+
<div class="member-signature"><span class="annotations">@Nonnull </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/arez/persist/Persist.html#line-47">setterName</a></span></div>
154+
<div class="block">Return the name of the setter.
155+
If unspecified the tool assumes that the setter method is named according to javabeans setter based on the derived
156+
<a href="#name()"><code>name()</code></a> of the property. So if the property is named <code>expanded</code> then the library will
157+
derive a setter method named <code>setExpanded</code>.</div>
158+
<dl class="notes">
159+
<dt>Returns:</dt>
160+
<dd>the name of the setter used to update value when restoring from a persisted store.</dd>
161+
</dl>
162+
<dl class="notes">
163+
<dt>Default:</dt>
164+
<dd>"&lt;default&gt;"</dd>
165+
</dl>
166+
</section>
167+
</li>
145168
</ul>
146169
</section>
147170
</li>

persist/index-all.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,10 @@ <h2 class="title" id="I:S">S</h2>
363363
<dd>
364364
<div class="block">Specify logger to use to capture logging in tests</div>
365365
</dd>
366+
<dt><a href="arez/persist/Persist.html#setterName()" class="member-name-link">setterName()</a> - Element in annotation interface arez.persist.<a href="arez/persist/Persist.html" title="annotation interface in arez.persist">Persist</a></dt>
367+
<dd>
368+
<div class="block">Return the name of the setter.</div>
369+
</dd>
366370
<dt><a href="arez/persist/runtime/ArezPersist.html#shouldCheckApiInvariants()" class="member-name-link">shouldCheckApiInvariants()</a> - Static method in class arez.persist.runtime.<a href="arez/persist/runtime/ArezPersist.html" title="class in arez.persist.runtime">ArezPersist</a></dt>
367371
<dd>
368372
<div class="block">Return true if apiInvariants will be checked.</div>

persist/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.

persist/src-html/arez/persist/Persist.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,18 @@
4848
<span class="source-line-no">035</span><span id="line-35"> */</span>
4949
<span class="source-line-no">036</span><span id="line-36"> @Nonnull</span>
5050
<span class="source-line-no">037</span><span id="line-37"> String store() default "&lt;default&gt;";</span>
51-
<span class="source-line-no">038</span><span id="line-38">}</span>
51+
<span class="source-line-no">038</span><span id="line-38"></span>
52+
<span class="source-line-no">039</span><span id="line-39"> /**</span>
53+
<span class="source-line-no">040</span><span id="line-40"> * Return the name of the setter.</span>
54+
<span class="source-line-no">041</span><span id="line-41"> * If unspecified the tool assumes that the setter method is named according to javabeans setter based on the derived</span>
55+
<span class="source-line-no">042</span><span id="line-42"> * {@link #name()} of the property. So if the property is named {@code expanded} then the library will</span>
56+
<span class="source-line-no">043</span><span id="line-43"> * derive a setter method named {@code setExpanded}.</span>
57+
<span class="source-line-no">044</span><span id="line-44"> *</span>
58+
<span class="source-line-no">045</span><span id="line-45"> * @return the name of the setter used to update value when restoring from a persisted store.</span>
59+
<span class="source-line-no">046</span><span id="line-46"> */</span>
60+
<span class="source-line-no">047</span><span id="line-47"> @Nonnull</span>
61+
<span class="source-line-no">048</span><span id="line-48"> String setterName() default "&lt;default&gt;";</span>
62+
<span class="source-line-no">049</span><span id="line-49">}</span>
5263

5364

5465

0 commit comments

Comments
 (0)