Fix return type of Builder.set #5161
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryEagerGcSettings.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryEagerGcSettings.html 2023-07-17 14:27:40.000000000 +0000
@@ -11,6 +11,10 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/firestore/MemoryEagerGcSettings.html">MemoryEagerGcSettings</a> implements <a href="/docs/reference/android/com/google/firebase/firestore/MemoryGarbageCollectorSettings.html">MemoryGarbageCollectorSettings</a></pre>
</p>
<hr>
+ <p>Configures the SDK to use an eager garbage collector for memory cache. The eager garbage collector will attempt to remove any documents from SDK's memory cache as soon as it is no longer used. </p>
+ <p>This is the default garbage collector unless specified explicitly otherwise. </p>
+ <p>To use, create an instance using <code>MemoryEagerGcSettings#newBuilder().build()</code>, then set the instance to <code>MemoryCacheSettings.Builder#setGcSettings</code>, and use the built <code>
+MemoryCacheSettings</code> instance to configure the Firestore SDK.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryGarbageCollectorSettings.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryGarbageCollectorSettings.html 2023-07-17 14:27:40.000000000 +0000
@@ -23,11 +23,15 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryEagerGcSettings.html">MemoryEagerGcSettings</a></code></td>
- <td></td>
+ <td>
+ <p>Configures the SDK to use an eager garbage collector for memory cache.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.html">MemoryLruGcSettings</a></code></td>
- <td></td>
+ <td>
+ <p>Configures the SDK to use a Least-Recently-Used garbage collector for memory cache.</p>
+ </td>
</tr>
</tbody>
</table>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html 2023-07-17 14:27:40.000000000 +0000
@@ -31,9 +31,10 @@
</td>
</tr>
<tr>
- <td><code>void</code></td>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(long size)</code></div>
+ <p>Sets an approximate cache size threshold for the memory cache.</p>
</td>
</tr>
</tbody>
@@ -47,7 +48,30 @@
</div>
<div class="api-item"><a name="setSizeBytes-long-"></a><a name="setsizebytes"></a>
<h3 class="api-name" id="setSizeBytes(long)">setSizeBytes</h3>
- <pre class="api-signature no-pretty-print">public void <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(long size)</pre>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(long size)</pre>
+ <p>Sets an approximate cache size threshold for the memory cache. If the cache grows beyond this size, Firestore SDK will start removing data that hasn't been recently used. The size is not a guarantee that the cache will stay below that size, only that if the cache exceeds the given size, cleanup will be attempted. </p>
+ <p>A default size of 100MB (100 * 1024 * 1024) is used if unset. The minimum value to set is 1 MB (1024 * 1024).</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code></td>
+ <td>
+ <p>this <code>Builder</code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryLruGcSettings.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryLruGcSettings.html 2023-07-17 14:27:40.000000000 +0000
@@ -11,6 +11,9 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.html">MemoryLruGcSettings</a> implements <a href="/docs/reference/android/com/google/firebase/firestore/MemoryGarbageCollectorSettings.html">MemoryGarbageCollectorSettings</a></pre>
</p>
<hr>
+ <p>Configures the SDK to use a Least-Recently-Used garbage collector for memory cache. </p>
+ <p>To use, create an instance using <code>MemoryLruGcSettings#newBuilder().build()</code>, then set the instance to <code>MemoryCacheSettings.Builder#setGcSettings</code>, and use the built <code>
+MemoryCacheSettings</code> instance to configure the Firestore SDK.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -75,6 +78,7 @@
<td><code>long</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.html#getSizeBytes()">getSizeBytes</a>()</code></div>
+ <p>Returns cache size threshold for the memory cache.</p>
</td>
</tr>
<tr>
@@ -87,6 +91,7 @@
<td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.html#newBuilder()">newBuilder</a>()</code></div>
+ <p>Returns a new instance of <code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code> with default configurations.</p>
</td>
</tr>
<tr>
@@ -114,6 +119,8 @@
<div class="api-item"><a name="getSizeBytes--"></a><a name="getsizebytes"></a>
<h3 class="api-name" id="getSizeBytes()">getSizeBytes</h3>
<pre class="api-signature no-pretty-print">public long <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.html#getSizeBytes()">getSizeBytes</a>()</pre>
+ <p>Returns cache size threshold for the memory cache. If the cache grows beyond this size, Firestore SDK will start removing data that hasn't been recently used. The size is not a guarantee that the cache will stay below that size, only that if the cache exceeds the given size, cleanup will be attempted. </p>
+ <p>By default, memory LRU cache is enabled with a cache size of 100MB (100 * 1024 * 1024). The minimum value is 1 MB (1024 * 1024).</p>
</div>
<div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
<h3 class="api-name" id="hashCode()">hashCode</h3>
@@ -122,6 +129,7 @@
<div class="api-item"><a name="newBuilder--"></a><a name="newbuilder"></a>
<h3 class="api-name" id="newBuilder()">newBuilder</h3>
<pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.html#newBuilder()">newBuilder</a>()</pre>
+ <p>Returns a new instance of <code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code> with default configurations.</p>
</div>
<div class="api-item"><a name="toString--"></a><a name="tostring"></a>
<h3 class="api-name" id="toString()">toString</h3>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2023-07-17 14:27:40.000000000 +0000
@@ -223,7 +223,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryEagerGcSettings.html">MemoryEagerGcSettings</a></code></td>
- <td></td>
+ <td>
+ <p>Configures the SDK to use an eager garbage collector for memory cache.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryEagerGcSettings.Builder.html">MemoryEagerGcSettings.Builder</a></code></td>
@@ -231,7 +233,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.html">MemoryLruGcSettings</a></code></td>
- <td></td>
+ <td>
+ <p>Configures the SDK to use a Least-Recently-Used garbage collector for memory cache.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code></td>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryEagerGcSettings.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryEagerGcSettings.html 2023-07-17 14:27:40.000000000 +0000
@@ -11,6 +11,10 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryEagerGcSettings.html">MemoryEagerGcSettings</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryGarbageCollectorSettings.html">MemoryGarbageCollectorSettings</a></pre>
</p>
<hr>
+ <p>Configures the SDK to use an eager garbage collector for memory cache. The eager garbage collector will attempt to remove any documents from SDK's memory cache as soon as it is no longer used. </p>
+ <p>This is the default garbage collector unless specified explicitly otherwise. </p>
+ <p>To use, create an instance using <code>MemoryEagerGcSettings#newBuilder().build()</code>, then set the instance to <code>MemoryCacheSettings.Builder#setGcSettings</code>, and use the built <code>
+MemoryCacheSettings</code> instance to configure the Firestore SDK.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryGarbageCollectorSettings.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryGarbageCollectorSettings.html 2023-07-17 14:27:40.000000000 +0000
@@ -23,11 +23,15 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryEagerGcSettings.html">MemoryEagerGcSettings</a></code></td>
- <td></td>
+ <td>
+ <p>Configures the SDK to use an eager garbage collector for memory cache.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.html">MemoryLruGcSettings</a></code></td>
- <td></td>
+ <td>
+ <p>Configures the SDK to use a Least-Recently-Used garbage collector for memory cache.</p>
+ </td>
</tr>
</tbody>
</table>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html 2023-07-17 14:27:40.000000000 +0000
@@ -31,9 +31,10 @@
</td>
</tr>
<tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(size: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>)</code></div>
+ <p>Sets an approximate cache size threshold for the memory cache.</p>
</td>
</tr>
</tbody>
@@ -47,7 +48,30 @@
</div>
<div class="api-item"><a name="setSizeBytes-long-"></a><a name="setsizebytes"></a>
<h3 class="api-name" id="setSizeBytes(long)">setSizeBytes</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(size: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(size: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></pre>
+ <p>Sets an approximate cache size threshold for the memory cache. If the cache grows beyond this size, Firestore SDK will start removing data that hasn't been recently used. The size is not a guarantee that the cache will stay below that size, only that if the cache exceeds the given size, cleanup will be attempted. </p>
+ <p>A default size of 100MB (100 * 1024 * 1024) is used if unset. The minimum value to set is 1 MB (1024 * 1024).</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code></td>
+ <td>
+ <p>this <code>Builder</code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.html 2023-07-17 14:27:40.000000000 +0000
@@ -11,6 +11,9 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.html">MemoryLruGcSettings</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryGarbageCollectorSettings.html">MemoryGarbageCollectorSettings</a></pre>
</p>
<hr>
+ <p>Configures the SDK to use a Least-Recently-Used garbage collector for memory cache. </p>
+ <p>To use, create an instance using <code>MemoryLruGcSettings#newBuilder().build()</code>, then set the instance to <code>MemoryCacheSettings.Builder#setGcSettings</code>, and use the built <code>
+MemoryCacheSettings</code> instance to configure the Firestore SDK.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -60,6 +63,7 @@
<td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.html#newBuilder()">newBuilder</a>()</code></div>
+ <p>Returns a new instance of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code> with default configurations.</p>
</td>
</tr>
<tr>
@@ -105,6 +109,7 @@
<div class="api-item"><a name="newBuilder--"></a><a name="newbuilder"></a>
<h3 class="api-name" id="newBuilder()">newBuilder</h3>
<pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.html#newBuilder()">newBuilder</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></pre>
+ <p>Returns a new instance of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code> with default configurations.</p>
</div>
<div class="api-item"><a name="toString--"></a><a name="tostring"></a>
<h3 class="api-name" id="toString()">toString</h3>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2023-07-17 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2023-07-17 14:27:40.000000000 +0000
@@ -176,7 +176,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryEagerGcSettings.html">MemoryEagerGcSettings</a></code></td>
- <td></td>
+ <td>
+ <p>Configures the SDK to use an eager garbage collector for memory cache.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryEagerGcSettings.Builder.html">MemoryEagerGcSettings.Builder</a></code></td>
@@ -184,7 +186,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.html">MemoryLruGcSettings</a></code></td>
- <td></td>
+ <td>
+ <p>Configures the SDK to use a Least-Recently-Used garbage collector for memory cache.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryLruGcSettings.Builder.html">MemoryLruGcSettings.Builder</a></code></td> |
Generated by 🚫 Danger |
Coverage Report 1Affected Products
Test Logs |
|
The public api surface has changed for the subproject firebase-firestore: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
|
The public api surface has changed for the subproject firebase-firestore: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
Size Report 1Affected Products
Test Logs |
dconeybe
requested changes
Jul 14, 2023
firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryEagerGcSettings.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryLruGcSettings.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryLruGcSettings.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryLruGcSettings.java
Outdated
Show resolved
Hide resolved
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
dconeybe
approved these changes
Jul 17, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Return type of MemoryLruGcSettings$Builder.setSizeBytes() should be the Builder itself, not void.