Path: blob/aarch64-shenandoah-jdk8u272-b10/jdk/src/share/classes/java/nio/file/attribute/package-info.java
38918 views
/*1* Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights reserved.2* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.3*4* This code is free software; you can redistribute it and/or modify it5* under the terms of the GNU General Public License version 2 only, as6* published by the Free Software Foundation. Oracle designates this7* particular file as subject to the "Classpath" exception as provided8* by Oracle in the LICENSE file that accompanied this code.9*10* This code is distributed in the hope that it will be useful, but WITHOUT11* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or12* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License13* version 2 for more details (a copy is included in the LICENSE file that14* accompanied this code).15*16* You should have received a copy of the GNU General Public License version17* 2 along with this work; if not, write to the Free Software Foundation,18* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.19*20* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA21* or visit www.oracle.com if you need additional information or have any22* questions.23*/2425/**26* Interfaces and classes providing access to file and file system attributes.27*28* <blockquote><table cellspacing=1 cellpadding=0 summary="Attribute views">29* <tr><th align="left">Attribute views</th><th align="left">Description</th></tr>30* <tr><td valign=top><tt><i>{@link java.nio.file.attribute.AttributeView}</i></tt></td>31* <td>Can read or update non-opaque values associated with objects in a file system</td></tr>32* <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.FileAttributeView}</i></tt></td>33* <td>Can read or update file attributes</td></tr>34* <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.BasicFileAttributeView} </i></tt></td>35* <td>Can read or update a basic set of file attributes</td></tr>36* <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.PosixFileAttributeView} </i></tt></td>37* <td>Can read or update POSIX defined file attributes</td></tr>38* <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.DosFileAttributeView} </i></tt></td>39* <td>Can read or update FAT file attributes</td></tr>40* <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.FileOwnerAttributeView} </i></tt></td>41* <td>Can read or update the owner of a file</td></tr>42* <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.AclFileAttributeView} </i></tt></td>43* <td>Can read or update Access Control Lists</td></tr>44* <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.UserDefinedFileAttributeView} </i></tt></td>45* <td>Can read or update user-defined file attributes</td></tr>46* <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.FileStoreAttributeView}</i></tt></td>47* <td>Can read or update file system attributes</td></tr>48* </table></blockquote>49*50* <p> An attribute view provides a read-only or updatable view of the non-opaque51* values, or <em>metadata</em>, associated with objects in a file system.52* The {@link java.nio.file.attribute.FileAttributeView} interface is53* extended by several other interfaces that that views to specific sets of file54* attributes. {@code FileAttributeViews} are selected by invoking the {@link55* java.nio.file.Files#getFileAttributeView} method with a56* <em>type-token</em> to identify the required view. Views can also be identified57* by name. The {@link java.nio.file.attribute.FileStoreAttributeView} interface58* provides access to file store attributes. A {@code FileStoreAttributeView} of59* a given type is obtained by invoking the {@link60* java.nio.file.FileStore#getFileStoreAttributeView} method.61*62* <p> The {@link java.nio.file.attribute.BasicFileAttributeView}63* class defines methods to read and update a <em>basic</em> set of file64* attributes that are common to many file systems.65*66* <p> The {@link java.nio.file.attribute.PosixFileAttributeView}67* interface extends {@code BasicFileAttributeView} by defining methods68* to access the file attributes commonly used by file systems and operating systems69* that implement the Portable Operating System Interface (POSIX) family of70* standards.71*72* <p> The {@link java.nio.file.attribute.DosFileAttributeView}73* class extends {@code BasicFileAttributeView} by defining methods to74* access the legacy "DOS" file attributes supported on file systems such as File75* Allocation Tabl (FAT), commonly used in consumer devices.76*77* <p> The {@link java.nio.file.attribute.AclFileAttributeView}78* class defines methods to read and write the Access Control List (ACL)79* file attribute. The ACL model used by this file attribute view is based80* on the model defined by <a href="http://www.ietf.org/rfc/rfc3530.txt">81* <i>RFC 3530: Network File System (NFS) version 4 Protocol</i></a>.82*83* <p> In addition to attribute views, this package also defines classes and84* interfaces that are used when accessing attributes:85*86* <ul>87*88* <li> The {@link java.nio.file.attribute.UserPrincipal} and89* {@link java.nio.file.attribute.GroupPrincipal} interfaces represent an90* identity or group identity. </li>91*92* <li> The {@link java.nio.file.attribute.UserPrincipalLookupService}93* interface defines methods to lookup user or group principals. </li>94*95* <li> The {@link java.nio.file.attribute.FileAttribute} interface96* represents the value of an attribute for cases where the attribute value is97* required to be set atomically when creating an object in the file system. </li>98*99* </ul>100*101*102* <p> Unless otherwise noted, passing a <tt>null</tt> argument to a constructor103* or method in any class or interface in this package will cause a {@link104* java.lang.NullPointerException NullPointerException} to be thrown.105*106* @since 1.7107*/108109package java.nio.file.attribute;110111112