Skip to content

Document FileStore space properties #459

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

Open
jonathanpeppers wants to merge 2 commits into
base: main
Choose a base branch
from
+34 −8
Open

Document FileStore space properties #459

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b243440
Document FileStore space properties
jonathanpeppers Aug 14, 2026
76be6d2
Document FileStore I/O failures
jonathanpeppers Aug 15, 2026
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
42 changes: 34 additions & 8 deletions docs/xml/Java.Nio.FileNio/FileStore.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,9 +296,15 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets whether this file store is read-only.</summary>
<value><c>true</c> if and only if this file store is read-only; otherwise, <c>false</c>.</value>
<remarks>
<para>A file store is read-only when it does not support write operations or other changes to files. Attempts to create a file or open an existing file for writing cause an <c>IOException</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/file/FileStore#isReadOnly()" title="Reference documentation">Java documentation for <code>java.nio.file.FileStore.isReadOnly()</code>.</a>
</format>
</para>
<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>
</Docs>
Expand Down Expand Up @@ -581,11 +587,17 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the size of this file store in bytes.</summary>
<value>The size of this file store in bytes, or <c>long.MaxValue</c> if its size exceeds that value.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/file/FileStore#getTotalSpace()" title="Reference documentation">Java documentation for <code>java.nio.file.FileStore.getTotalSpace()</code>.</a>
</format>
</para>
<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>
<exception cref="T:Java.IO.IOException">If an I/O error occurs.</exception>
</Docs>
</Member>
<Member MemberName="Type">
Expand Down Expand Up @@ -657,11 +669,18 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the number of unallocated bytes in this file store.</summary>
<value>The number of unallocated bytes, or <c>long.MaxValue</c> if the number exceeds that value.</value>
<remarks>
<para>This value is a hint, not a guarantee; it is most accurate immediately after retrieval and may be affected by external I/O operations.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/file/FileStore#getUnallocatedSpace()" title="Reference documentation">Java documentation for <code>java.nio.file.FileStore.getUnallocatedSpace()</code>.</a>
</format>
</para>
<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>
<exception cref="T:Java.IO.IOException">If an I/O error occurs.</exception>
</Docs>
</Member>
<Member MemberName="UsableSpace">
Expand All @@ -688,11 +707,18 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the number of bytes available to this Java virtual machine on this file store.</summary>
<value>The number of available bytes, or <c>long.MaxValue</c> if the number exceeds that value.</value>
<remarks>
<para>This value is a hint, not a guarantee; it is most accurate immediately after retrieval and may be affected by external I/O operations.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/file/FileStore#getUsableSpace()" title="Reference documentation">Java documentation for <code>java.nio.file.FileStore.getUsableSpace()</code>.</a>
</format>
</para>
<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>
<exception cref="T:Java.IO.IOException">If an I/O error occurs.</exception>
</Docs>
</Member>
</Members>
Expand Down