Skip to content

Commit de78e30

Browse files
Document FileStore space properties (#459)
* Document FileStore space properties Refs #210 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Document FileStore I/O failures Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Correct FileStore space value docs Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 2cde554 commit de78e30

1 file changed

Lines changed: 34 additions & 8 deletions

File tree

docs/xml/Java.Nio.FileNio/FileStore.xml

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -296,9 +296,15 @@
296296
<ReturnType>System.Boolean</ReturnType>
297297
</ReturnValue>
298298
<Docs>
299-
<summary>To be added.</summary>
300-
<value>To be added.</value>
299+
<summary>Gets whether this file store is read-only.</summary>
300+
<value><c>true</c> if and only if this file store is read-only; otherwise, <c>false</c>.</value>
301301
<remarks>
302+
<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>
303+
<para>
304+
<format type="text/html">
305+
<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>
306+
</format>
307+
</para>
302308
<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>
303309
</remarks>
304310
</Docs>
@@ -581,11 +587,17 @@
581587
<ReturnType>System.Int64</ReturnType>
582588
</ReturnValue>
583589
<Docs>
584-
<summary>To be added.</summary>
585-
<value>To be added.</value>
590+
<summary>Gets the size of this file store in bytes.</summary>
591+
<value>The size of this file store in bytes.</value>
586592
<remarks>
593+
<para>
594+
<format type="text/html">
595+
<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>
596+
</format>
597+
</para>
587598
<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>
588599
</remarks>
600+
<exception cref="T:Java.IO.IOException">If an I/O error occurs.</exception>
589601
</Docs>
590602
</Member>
591603
<Member MemberName="Type">
@@ -657,11 +669,18 @@
657669
<ReturnType>System.Int64</ReturnType>
658670
</ReturnValue>
659671
<Docs>
660-
<summary>To be added.</summary>
661-
<value>To be added.</value>
672+
<summary>Gets the number of unallocated bytes in this file store.</summary>
673+
<value>The number of unallocated bytes.</value>
662674
<remarks>
675+
<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>
676+
<para>
677+
<format type="text/html">
678+
<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>
679+
</format>
680+
</para>
663681
<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>
664682
</remarks>
683+
<exception cref="T:Java.IO.IOException">If an I/O error occurs.</exception>
665684
</Docs>
666685
</Member>
667686
<Member MemberName="UsableSpace">
@@ -688,11 +707,18 @@
688707
<ReturnType>System.Int64</ReturnType>
689708
</ReturnValue>
690709
<Docs>
691-
<summary>To be added.</summary>
692-
<value>To be added.</value>
710+
<summary>Gets the number of bytes available to this Java virtual machine on this file store.</summary>
711+
<value>The number of available bytes.</value>
693712
<remarks>
713+
<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>
714+
<para>
715+
<format type="text/html">
716+
<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>
717+
</format>
718+
</para>
694719
<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>
695720
</remarks>
721+
<exception cref="T:Java.IO.IOException">If an I/O error occurs.</exception>
696722
</Docs>
697723
</Member>
698724
</Members>

0 commit comments

Comments
 (0)