Skip to content

Document Android.Util LruCache #561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 1 commit into from
Aug 16, 2026
+18 −19
Merged

Document Android.Util LruCache #561

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 18 additions & 19 deletions docs/xml/Android.Util/LruCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,7 @@
<param name="maxSize">for caches that do not override <c>#sizeOf</c>, this is
the maximum number of entries in the cache. For all other caches,
this is the maximum sum of the sizes of the entries in this cache.</param>
<summary>
</summary>
<summary>Initializes a cache with the specified maximum size.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -161,9 +160,9 @@
<Parameter Name="key" Type="Java.Lang.Object" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="key">The key for which to compute a value.</param>
<summary>Called after a cache miss to compute a value for the corresponding key.</summary>
<returns>To be added.</returns>
<returns>The computed value, or <c>null</c> if no value can be computed.</returns>
<remarks>
<para>Called after a cache miss to compute a value for the corresponding key.
Returns the computed value or null if no value can be computed. The
Expand Down Expand Up @@ -211,7 +210,7 @@
<Parameters />
<Docs>
<summary>Returns the number of times <c>#create(Object)</c> returned a value.</summary>
<returns>To be added.</returns>
<returns>The number of times <c>#create</c> returned a value.</returns>
<remarks>
<para>Returns the number of times <c>#create(Object)</c> returned a value.</para>
<para>
Expand Down Expand Up @@ -342,7 +341,7 @@
<Parameters />
<Docs>
<summary>Returns the number of values that have been evicted.</summary>
<returns>To be added.</returns>
<returns>The number of values that have been evicted.</returns>
<remarks>
<para>Returns the number of values that have been evicted.</para>
<para>
Expand Down Expand Up @@ -382,10 +381,10 @@
<Parameter Name="key" Type="Java.Lang.Object" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="key">The key to retrieve.</param>
<summary>Returns the value for <c>key</c> if it exists in the cache or can be
created by <c>#create</c>.</summary>
<returns>To be added.</returns>
<returns>The cached or newly created value, or <c>null</c> if the value is neither cached nor created.</returns>
<remarks>
<para>Returns the value for <c>key</c> if it exists in the cache or can be
created by <c>#create</c>. If a value was returned, it is moved to the
Expand Down Expand Up @@ -427,7 +426,7 @@
<Docs>
<summary>Returns the number of times <c>#get</c> returned a value that was
already present in the cache.</summary>
<returns>To be added.</returns>
<returns>The number of times <c>#get</c> returned a value already present in the cache.</returns>
<remarks>
<para>Returns the number of times <c>#get</c> returned a value that was
already present in the cache.</para>
Expand Down Expand Up @@ -503,7 +502,7 @@
<Docs>
<summary>For caches that do not override <c>#sizeOf</c>, this returns the maximum
number of entries in the cache.</summary>
<returns>To be added.</returns>
<returns>The maximum size in the cache's units.</returns>
<remarks>
<para>For caches that do not override <c>#sizeOf</c>, this returns the maximum
number of entries in the cache. For all other caches, this returns the
Expand Down Expand Up @@ -545,7 +544,7 @@
<Docs>
<summary>Returns the number of times <c>#get</c> returned null or required a new
value to be created.</summary>
<returns>To be added.</returns>
<returns>The number of times <c>#get</c> returned <c>null</c> or required a new value to be created.</returns>
<remarks>
<para>Returns the number of times <c>#get</c> returned null or required a new
value to be created.</para>
Expand Down Expand Up @@ -587,8 +586,8 @@
<Parameter Name="value" Type="Java.Lang.Object" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<param name="key">The key to associate with <paramref name="value" />.</param>
<param name="value">The value to cache for <paramref name="key" />.</param>
<summary>Caches <c>value</c> for <c>key</c>.</summary>
<returns>the previous value mapped by <c>key</c>.</returns>
<remarks>
Expand Down Expand Up @@ -629,7 +628,7 @@
<Parameters />
<Docs>
<summary>Returns the number of times <c>#put</c> was called.</summary>
<returns>To be added.</returns>
<returns>The number of times <c>#put</c> was called.</returns>
<remarks>
<para>Returns the number of times <c>#put</c> was called.</para>
<para>
Expand Down Expand Up @@ -669,7 +668,7 @@
<Parameter Name="key" Type="Java.Lang.Object" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="key">The key whose entry is removed.</param>
<summary>Removes the entry for <c>key</c> if it exists.</summary>
<returns>the previous value mapped by <c>key</c>.</returns>
<remarks>
Expand Down Expand Up @@ -750,7 +749,7 @@
<Docs>
<summary>For caches that do not override <c>#sizeOf</c>, this returns the number
of entries in the cache.</summary>
<returns>To be added.</returns>
<returns>The cache size in its configured units.</returns>
<remarks>
<para>For caches that do not override <c>#sizeOf</c>, this returns the number
of entries in the cache. For all other caches, this returns the sum of
Expand Down Expand Up @@ -797,7 +796,7 @@
<param name="value">To be added.</param>
<summary>Returns the size of the entry for <c>key</c> and <c>value</c> in
user-defined units.</summary>
<returns>To be added.</returns>
<returns>The entry size in user-defined units.</returns>
<remarks>
<para>Returns the size of the entry for <c>key</c> and <c>value</c> in
user-defined units. The default implementation returns 1 so that size
Expand Down Expand Up @@ -839,7 +838,7 @@
<Docs>
<summary>Returns a copy of the current contents of the cache, ordered from least
recently accessed to most recently accessed.</summary>
<returns>To be added.</returns>
<returns>A copy of the cache contents, ordered from least recently accessed to most recently accessed.</returns>
<remarks>
<para>Returns a copy of the current contents of the cache, ordered from least
recently accessed to most recently accessed.</para>
Expand Down Expand Up @@ -946,7 +945,7 @@
<Docs>
<summary>Returns a string containing a concise, human-readable description of this
object.</summary>
<returns>To be added.</returns>
<returns>A string representation of the cache.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down