Skip to content

Document Java NIO file attributes #579

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
+182 −213
Open

Document Java NIO file attributes #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3576e57
Document Java NIO file attributes
jonathanpeppers Aug 15, 2026
238a95b
Address NIO attribute documentation review
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
45 changes: 21 additions & 24 deletions docs/xml/Java.Nio.FileNio.Attributes/AclEntry+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,7 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the JNI peer metadata used by the .NET for Android binding runtime.</summary>
Comment thread
jonathanpeppers marked this conversation as resolved.
<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 Expand Up @@ -164,9 +163,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="flags">The flags to associate with the entry.</param>
<summary>Sets the inheritance and propagation flags for the ACL entry being built.</summary>
<returns>This builder.</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 Expand Up @@ -206,9 +205,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="flags">The flags to associate with the entry.</param>
<summary>Sets the inheritance and propagation flags for the ACL entry being built.</summary>
<returns>This builder.</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 Expand Up @@ -252,9 +251,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="perms">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="perms">The permissions to associate with the entry.</param>
<summary>Sets the permissions for the ACL entry being built.</summary>
<returns>This builder.</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 Expand Up @@ -294,9 +293,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="perms">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="perms">The permissions to associate with the entry.</param>
<summary>Sets the permissions for the ACL entry being built.</summary>
<returns>This builder.</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 Expand Up @@ -329,9 +328,9 @@
<Parameter Name="who" Type="Java.Nio.FileNio.Attributes.IUserPrincipal" />
</Parameters>
<Docs>
<param name="who">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="who">The user principal for the entry.</param>
<summary>Sets the principal to which the ACL entry applies.</summary>
<returns>This builder.</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 Expand Up @@ -364,9 +363,9 @@
<Parameter Name="type" Type="Java.Nio.FileNio.Attributes.AclEntryType" />
</Parameters>
<Docs>
<param name="type">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="type">The ACL entry type.</param>
<summary>Sets whether the ACL entry allows, denies, audits, or alarms access.</summary>
<returns>This builder.</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 Expand Up @@ -396,8 +395,7 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<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 Expand Up @@ -431,8 +429,7 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<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
11 changes: 4 additions & 7 deletions docs/xml/Java.Nio.FileNio.Attributes/AclEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,7 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the JNI peer metadata used by the .NET for Android binding runtime.</summary>
Comment thread
jonathanpeppers marked this conversation as resolved.
<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 Expand Up @@ -222,7 +221,7 @@
<Parameter Name="entry" Type="Java.Nio.FileNio.Attributes.AclEntry" />
</Parameters>
<Docs>
<param name="entry">To be added.</param>
<param name="entry">The ACL entry whose components initialize the builder.</param>
<summary>Constructs a new builder.</summary>
<returns>a new builder</returns>
<remarks>
Expand Down Expand Up @@ -354,8 +353,7 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<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 Expand Up @@ -385,8 +383,7 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<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
35 changes: 16 additions & 19 deletions docs/xml/Java.Nio.FileNio.Attributes/AclEntryFlag.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@
<ReturnType>Java.Nio.FileNio.Attributes.AclEntryFlag</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Specifies that the ACL entry is inherited by new directories.</summary>
<value>Specifies that the ACL entry is inherited by new directories.</value>
<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 Expand Up @@ -101,8 +101,8 @@
<ReturnType>Java.Nio.FileNio.Attributes.AclEntryFlag</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Specifies that the ACL entry is inherited by new files.</summary>
<value>Specifies that the ACL entry is inherited by new files.</value>
<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 Expand Up @@ -132,8 +132,8 @@
<ReturnType>Java.Nio.FileNio.Attributes.AclEntryFlag</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Specifies that the ACL entry does not apply to the object on which it is defined.</summary>
<value>Specifies that the ACL entry does not apply to the object on which it is defined.</value>
<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 Expand Up @@ -167,8 +167,7 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the JNI peer metadata used by the .NET for Android binding runtime.</summary>
Comment thread
jonathanpeppers marked this conversation as resolved.
<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 Expand Up @@ -198,8 +197,8 @@
<ReturnType>Java.Nio.FileNio.Attributes.AclEntryFlag</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Specifies that inheritance stops after the entry is inherited once.</summary>
<value>Specifies that inheritance stops after the entry is inherited once.</value>
<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 Expand Up @@ -229,8 +228,7 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<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 Expand Up @@ -264,8 +262,7 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<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 Expand Up @@ -298,9 +295,9 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="name">The name of the enum constant to return.</param>
<summary>Returns the enum constant with the specified name.</summary>
<returns>The enum constant whose name matches the supplied name.</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 Expand Up @@ -337,8 +334,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns the constants of this enum type in declaration order.</summary>
<returns>An array containing the enum constants in declaration order.</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
Loading