1 /*
2 * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 /**
27 * Interfaces and classes providing access to file and file system attributes.
28 *
29 * <blockquote><table cellspacing=1 cellpadding=0 summary="Attribute views">
30 * <tr><th><p align="left">Attribute views</p></th><th><p align="left">Description</p></th></tr>
31 * <tr><td valign=top><tt><i>{@link java.nio.file.attribute.AttributeView}</i></tt></td>
32 * <td>Can read or update non-opaque values associated with objects in a file system</td></tr>
33 * <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.FileAttributeView}</i></tt></td>
34 * <td>Can read or update file attributes</td></tr>
35 * <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.BasicFileAttributeView} </i></tt></td>
36 * <td>Can read or update a basic set of file attributes</td></tr>
37 * <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.PosixFileAttributeView} </i></tt></td>
38 * <td>Can read or update POSIX defined file attributes</td></tr>
39 * <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.DosFileAttributeView} </i></tt></td>
40 * <td>Can read or update FAT file attributes</td></tr>
41 * <tr><td valign=top><tt>  <i>{@link java.nio.file.attribute.FileOwnerAttributeView} </i></tt></td>
42 * <td>Can read or update the owner of a file</td></tr>
43 * <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.AclFileAttributeView} </i></tt></td>
44 * <td>Can read or update Access Control Lists</td></tr>
45 * <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.UserDefinedFileAttributeView} </i></tt></td>
46 * <td>Can read or update user-defined file attributes</td></tr>
47 * <tr><td valign=top><tt> <i>{@link java.nio.file.attribute.FileStoreAttributeView}</i></tt></td>
48 * <td>Can read or update file system attributes</td></tr>
49 * </table></blockquote>
50 *
51 * <p> An attribute view provides a read-only or updatable view of the non-opaque
52 * values, or <em>metadata</em>, associated with objects in a file system.
53 * The {@link java.nio.file.attribute.FileAttributeView} interface is
54 * extended by several other interfaces that that views to specific sets of file
55 * attributes. {@code FileAttributeViews} are selected by invoking the {@link
56 * java.nio.file.Files#getFileAttributeView} method with a
57 * <em>type-token</em> to identify the required view. Views can also be identified
58 * by name. The {@link java.nio.file.attribute.FileStoreAttributeView} interface
59 * provides access to file store attributes. A {@code FileStoreAttributeView} of
60 * a given type is obtained by invoking the {@link
61 * java.nio.file.FileStore#getFileStoreAttributeView} method.
62 *
63 * <p> The {@link java.nio.file.attribute.BasicFileAttributeView}
64 * class defines methods to read and update a <em>basic</em> set of file
65 * attributes that are common to many file systems.
66 *
67 * <p> The {@link java.nio.file.attribute.PosixFileAttributeView}
68 * interface extends {@code BasicFileAttributeView} by defining methods
69 * to access the file attributes commonly used by file systems and operating systems
70 * that implement the Portable Operating System Interface (POSIX) family of
71 * standards.
72 *
73 * <p> The {@link java.nio.file.attribute.DosFileAttributeView}
74 * class extends {@code BasicFileAttributeView} by defining methods to
75 * access the legacy "DOS" file attributes supported on file systems such as File
76 * Allocation Tabl (FAT), commonly used in consumer devices.
77 *
78 * <p> The {@link java.nio.file.attribute.AclFileAttributeView}
79 * class defines methods to read and write the Access Control List (ACL)
80 * file attribute. The ACL model used by this file attribute view is based
81 * on the model defined by <a href="http://www.ietf.org/rfc/rfc3530.txt">
82 * <i>RFC 3530: Network File System (NFS) version 4 Protocol</i></a>.
83 *
84 * <p> In addition to attribute views, this package also defines classes and
85 * interfaces that are used when accessing attributes:
86 *
87 * <ul>
88 *
89 * <p><li> The {@link java.nio.file.attribute.UserPrincipal} and
90 * {@link java.nio.file.attribute.GroupPrincipal} interfaces represent an
91 * identity or group identity. </li>
92 *
93 * <p><li> The {@link java.nio.file.attribute.UserPrincipalLookupService}
94 * interface defines methods to lookup user or group principals. </li>
95 *
96 * <p><li> The {@link java.nio.file.attribute.FileAttribute} interface
97 * represents the value of an attribute for cases where the attribute value is
98 * required to be set atomically when creating an object in the file system. </li>
99 *
100 * </ul>
101 *
102 *
103 * <p> Unless otherwise noted, passing a <tt>null</tt> argument to a constructor
104 * or method in any class or interface in this package will cause a {@link
105 * java.lang.NullPointerException NullPointerException} to be thrown.
106 *
107 * @since 1.7
108 */
109
110 package java.nio.file.attribute;