1 /*
   2  * Copyright (c) 2007, 2017, 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  * <table class="striped" style="padding-left:2em; text-align:left">
  30  *     <caption style="display:none">Attribute views</caption>
  31  * <thead>
  32  * <tr><th scope="col">Attribute views</th>
  33  *     <th scope="col">Description</th></tr>
  34  * </thead>
  35  * <tbody>
  36  * <tr><th scope="row"><i>{@link java.nio.file.attribute.AttributeView}</i></th>
  37  *     <td>Can read or update non-opaque values associated with objects in a file system</td></tr>
  38  * <tr><th scope="row">
  39  *     <span style="padding-left:1em"><i>{@link java.nio.file.attribute.FileAttributeView}</i></span></th>
  40  *     <td>Can read or update file attributes</td></tr>
  41  * <tr><th scope="row">
  42  *     <span style="padding-left:2em">
  43  *     <i>{@link java.nio.file.attribute.BasicFileAttributeView}</i></span></th>
  44  *     <td>Can read or update a basic set of file attributes</td></tr>
  45  * <tr><th scope="row">
  46  *     <span style="padding-left:3em">
  47  *     <i>{@link java.nio.file.attribute.PosixFileAttributeView}</i></span></th>
  48  *     <td>Can read or update POSIX defined file attributes</td></tr>
  49  * <tr><th scope="row">
  50  *     <span style="padding-left:3em">
  51  *     <i>{@link java.nio.file.attribute.DosFileAttributeView}</i></span></th>
  52  *     <td>Can read or update FAT file attributes</td></tr>
  53  * <tr><th scope="row">
  54  *     <span style="padding-left:2em">
  55  *     <i>{@link java.nio.file.attribute.FileOwnerAttributeView}</i></span></th>
  56  *     <td>Can read or update the owner of a file</td></tr>
  57  * <tr><th scope="row">
  58  *     <span style="padding-left:3em">
  59  *     <i>{@link java.nio.file.attribute.AclFileAttributeView}</i></span></th>
  60  *     <td>Can read or update Access Control Lists</td></tr>
  61  * <tr><th scope="row">
  62  *     <span style="padding-left:2em">
  63  *     <i>{@link java.nio.file.attribute.UserDefinedFileAttributeView}</i></span></th>
  64  *     <td>Can read or update user-defined file attributes</td></tr>
  65  * <tr><th scope="row">
  66  *     <span style="padding-left:1em"><i>{@link java.nio.file.attribute.FileStoreAttributeView}</i></span></th>
  67  *     <td>Can read or update file system attributes</td></tr>
  68  * </tbody>
  69  * </table>
  70  *
  71  * <p> An attribute view provides a read-only or updatable view of the non-opaque
  72  * values, or <em>metadata</em>, associated with objects in a file system.
  73  * The {@link java.nio.file.attribute.FileAttributeView} interface is
  74  * extended by several other interfaces that provide views to specific sets of file
  75  * attributes. {@code FileAttributeViews} are selected by invoking the {@link
  76  * java.nio.file.Files#getFileAttributeView} method with a
  77  * <em>type-token</em> to identify the required view. Views can also be identified
  78  * by name. The {@link java.nio.file.attribute.FileStoreAttributeView} interface
  79  * provides access to file store attributes. A {@code FileStoreAttributeView} of
  80  * a given type is obtained by invoking the {@link
  81  * java.nio.file.FileStore#getFileStoreAttributeView} method.
  82  *
  83  * <p> The {@link java.nio.file.attribute.BasicFileAttributeView}
  84  * class defines methods to read and update a <em>basic</em> set of file
  85  * attributes that are common to many file systems.
  86  *
  87  * <p> The {@link java.nio.file.attribute.PosixFileAttributeView}
  88  * interface extends {@code BasicFileAttributeView} by defining methods
  89  * to access the file attributes commonly used by file systems and operating systems
  90  * that implement the Portable Operating System Interface (POSIX) family of
  91  * standards.
  92  *
  93  * <p> The {@link java.nio.file.attribute.DosFileAttributeView}
  94  * class extends {@code BasicFileAttributeView} by defining methods to
  95  * access the legacy "DOS" file attributes supported on file systems such as File
  96  * Allocation Tabl (FAT), commonly used in consumer devices.
  97  *
  98  * <p> The {@link java.nio.file.attribute.AclFileAttributeView}
  99  * class defines methods to read and write the Access Control List (ACL)
 100  * file attribute. The ACL model used by this file attribute view is based
 101  * on the model defined by <a href="http://www.ietf.org/rfc/rfc3530.txt">
 102  * <i>RFC&nbsp;3530: Network File System (NFS) version 4 Protocol</i></a>.
 103  *
 104  * <p> In addition to attribute views, this package also defines classes and
 105  * interfaces that are used when accessing attributes:
 106  *
 107  * <ul>
 108  *
 109  *   <li> The {@link java.nio.file.attribute.UserPrincipal} and
 110  *   {@link java.nio.file.attribute.GroupPrincipal} interfaces represent an
 111  *   identity or group identity. </li>
 112  *
 113  *   <li> The {@link java.nio.file.attribute.UserPrincipalLookupService}
 114  *   interface defines methods to lookup user or group principals. </li>
 115  *
 116  *   <li> The {@link java.nio.file.attribute.FileAttribute} interface
 117  *   represents the value of an attribute for cases where the attribute value is
 118  *   required to be set atomically when creating an object in the file system. </li>
 119  *
 120  * </ul>
 121  *
 122  *
 123  * <p> Unless otherwise noted, passing a {@code null} argument to a constructor
 124  * or method in any class or interface in this package will cause a {@link
 125  * java.lang.NullPointerException NullPointerException} to be thrown.
 126  *
 127  * @since 1.7
 128  */
 129 
 130 package java.nio.file.attribute;