The Java Tutorials have been written for JDK 8. Examples and practices described in this page don't take advantage of improvements introduced in later releases and might use technology no longer available.
SeeDev.java for updated tutorials taking advantage of the latest releases.
SeeJava Language Changes for a summary of updated language features in Java SE 9 and subsequent releases.
SeeJDK Release Notes for information about new features, enhancements, and removed or deprecated options for all JDK releases.

Managing Metadata (File and File Store Attributes)

The definition ofmetadata is "data about other data." With a file system, the data is contained in its files and directories, and the metadata tracks information about each of these objects: Is it a regular file, a directory, or a link? What is its size, creation date, last modified date, file owner, group owner, and access permissions?

A file system's metadata is typically referred to as itsfile attributes. TheFiles class includes methods that can be used to obtain a single attribute of a file, or to set an attribute.

If a program needs multiple file attributes around the same time, it can be inefficient to use methods that retrieve a single attribute. Repeatedly accessing the file system to retrieve a single attribute can adversely affect performance. For this reason, theFiles class provides tworeadAttributes methods to fetch a file's attributes in one bulk operation.

Before showing examples of thereadAttributes methods, it should be mentioned that different file systems have different notions about which attributes should be tracked. For this reason, related file attributes are grouped together into views. Aview maps to a particular file system implementation, such as POSIX or DOS, or to a common functionality, such as file ownership.

The supported views are as follows:

• BasicFileAttributeView – Provides a view of basic attributes that are required to be supported by all file system implementations.
• DosFileAttributeView – Extends the basic attribute view with the standard four bits supported on file systems that support the DOS attributes.
• PosixFileAttributeView – Extends the basic attribute view with attributes supported on file systems that support the POSIX family of standards, such as UNIX. These attributes include file owner, group owner, and the nine related access permissions.
• FileOwnerAttributeView – Supported by any file system implementation that supports the concept of a file owner.
• AclFileAttributeView – Supports reading or updating a file's Access Control Lists (ACL). The NFSv4 ACL model is supported. Any ACL model, such as the Windows ACL model, that has a well-defined mapping to the NFSv4 model might also be supported.
• UserDefinedFileAttributeView – Enables support of metadata that is user defined. This view can be mapped to any extension mechanisms that a system supports. In the Solaris OS, for example, you can use this view to store the MIME type of a file.

A specific file system implementation might support only the basic file attribute view, or it may support several of these file attribute views. A file system implementation might support other attribute views not included in this API.

In most instances, you should not have to deal directly with any of theFileAttributeView interfaces. (If you do need to work directly with theFileAttributeView, you can access it via thegetFileAttributeView(Path, Class<V>, LinkOption...) method.)

ThereadAttributes methods use generics and can be used to read the attributes for any of the file attributes views. The examples in the rest of this page use thereadAttributes methods.

The remainder of this section covers the following topics:

• Basic File Attributes
• Setting Time Stamps
• DOS File Attributes
• POSIX File Permissions
• Setting a File or Group Owner
• User-Defined File Attributes
• File Store Attributes

Basic File Attributes

As mentioned previously, to read the basic attributes of a file, you can use one of theFiles.readAttributes methods, which reads all the basic attributes in one bulk operation. This is far more efficient than accessing the file system separately to read each individual attribute. The varargs argument currently supports theLinkOption enum,NOFOLLOW_LINKS. Use this option when you do not want symbolic links to be followed.

The following code snippet reads and prints the basic file attributes for a given file and uses the methods in theBasicFileAttributes class.

Path file = ...;BasicFileAttributes attr = Files.readAttributes(file, BasicFileAttributes.class);System.out.println("creationTime: " + attr.creationTime());System.out.println("lastAccessTime: " + attr.lastAccessTime());System.out.println("lastModifiedTime: " + attr.lastModifiedTime());System.out.println("isDirectory: " + attr.isDirectory());System.out.println("isOther: " + attr.isOther());System.out.println("isRegularFile: " + attr.isRegularFile());System.out.println("isSymbolicLink: " + attr.isSymbolicLink());System.out.println("size: " + attr.size());

In addition to the accessor methods shown in this example, there is afileKey method that returns either an object that uniquely identifies the file ornull if no file key is available.

Setting Time Stamps

The following code snippet sets the last modified time in milliseconds:

Path file = ...;BasicFileAttributes attr =    Files.readAttributes(file, BasicFileAttributes.class);long currentTime = System.currentTimeMillis();FileTime ft = FileTime.fromMillis(currentTime);Files.setLastModifiedTime(file, ft);}

DOS File Attributes

DOS file attributes are also supported on file systems other than DOS, such as Samba. The following snippet uses the methods of theDosFileAttributes class.

Path file = ...;try {    DosFileAttributes attr =        Files.readAttributes(file, DosFileAttributes.class);    System.out.println("isReadOnly is " + attr.isReadOnly());    System.out.println("isHidden is " + attr.isHidden());    System.out.println("isArchive is " + attr.isArchive());    System.out.println("isSystem is " + attr.isSystem());} catch (UnsupportedOperationException x) {    System.err.println("DOS file" +        " attributes not supported:" + x);}

However, you can set a DOS attribute using thesetAttribute(Path, String, Object, LinkOption...) method, as follows:

Path file = ...;Files.setAttribute(file, "dos:hidden", true);

POSIX File Permissions

POSIX is an acronym for Portable Operating System Interface for UNIX and is a set of IEEE and ISO standards designed to ensure interoperability among different flavors of UNIX. If a program conforms to these POSIX standards, it should be easily ported to other POSIX-compliant operating systems.

Besides file owner and group owner, POSIX supports nine file permissions: read, write, and execute permissions for the file owner, members of the same group, and "everyone else."

The following code snippet reads the POSIX file attributes for a given file and prints them to standard output. The code uses the methods in thePosixFileAttributes class.

Path file = ...;PosixFileAttributes attr =    Files.readAttributes(file, PosixFileAttributes.class);System.out.format("%s %s %s%n",    attr.owner().getName(),    attr.group().getName(),    PosixFilePermissions.toString(attr.permissions()));

ThePosixFilePermissions helper class provides several useful methods, as follows:

• ThetoString method, used in the previous code snippet, converts the file permissions to a string (for example,rw-r--r--).
• ThefromString method accepts a string representing the file permissions and constructs aSet of file permissions.
• TheasFileAttribute method accepts aSet of file permissions and constructs a file attribute that can be passed to thePath.createFile orPath.createDirectory method.

The following code snippet reads the attributes from one file and creates a new file, assigning the attributes from the original file to the new file:

Path sourceFile = ...;Path newFile = ...;PosixFileAttributes attrs =    Files.readAttributes(sourceFile, PosixFileAttributes.class);FileAttribute<Set<PosixFilePermission>> attr =    PosixFilePermissions.asFileAttribute(attrs.permissions());Files.createFile(file, attr);

TheasFileAttribute method wraps the permissions as aFileAttribute. The code then attempts to create a new file with those permissions. Note that theumask also applies, so the new file might be more secure than the permissions that were requested.

To set a file's permissions to values represented as a hard-coded string, you can use the following code:

Path file = ...;Set<PosixFilePermission> perms =    PosixFilePermissions.fromString("rw-------");FileAttribute<Set<PosixFilePermission>> attr =    PosixFilePermissions.asFileAttribute(perms);Files.setPosixFilePermissions(file, perms);

TheChmod example recursively changes the permissions of files in a manner similar to thechmod utility.

Setting a File or Group Owner

To translate a name into an object you can store as a file owner or a group owner, you can use theUserPrincipalLookupService service. This service looks up a name or group name as a string and returns aUserPrincipal object representing that string. You can obtain the user principal look-up service for the default file system by using theFileSystem.getUserPrincipalLookupService method.

The following code snippet shows how to set the file owner by using thesetOwner method:

Path file = ...;UserPrincipal owner = file.GetFileSystem().getUserPrincipalLookupService()        .lookupPrincipalByName("sally");Files.setOwner(file, owner);

There is no special-purpose method in theFiles class for setting a group owner. However, a safe way to do so directly is through the POSIX file attribute view, as follows:

Path file = ...;GroupPrincipal group =    file.getFileSystem().getUserPrincipalLookupService()        .lookupPrincipalByGroupName("green");Files.getFileAttributeView(file, PosixFileAttributeView.class)     .setGroup(group);

User-Defined File Attributes

If the file attributes supported by your file system implementation aren't sufficient for your needs, you can use theUserDefinedAttributeView to create and track your own file attributes.

Some implementations map this concept to features like NTFS Alternative Data Streams and extended attributes on file systems such as ext3 and ZFS. Most implementations impose restrictions on the size of the value, for example, ext3 limits the size to 4 kilobytes.

A file's MIME type can be stored as a user-defined attribute by using this code snippet:

Path file = ...;UserDefinedFileAttributeView view = Files    .getFileAttributeView(file, UserDefinedFileAttributeView.class);view.write("user.mimetype",           Charset.defaultCharset().encode("text/html");

To read the MIME type attribute, you would use this code snippet:

Path file = ...;UserDefinedFileAttributeView view = Files.getFileAttributeView(file,UserDefinedFileAttributeView.class);String name = "user.mimetype";ByteBuffer buf = ByteBuffer.allocate(view.size(name));view.read(name, buf);buf.flip();String value = Charset.defaultCharset().decode(buf).toString();

TheXdd example shows how to get, set, and delete a user-defined attribute.

$ sudo mount -o remount,user_xattr /

File Store Attributes

You can use theFileStore class to learn information about a file store, such as how much space is available. ThegetFileStore(Path) method fetches the file store for the specified file.

The following code snippet prints the space usage for the file store where a particular file resides:

Path file = ...;FileStore store = Files.getFileStore(file);long total = store.getTotalSpace() / 1024;long used = (store.getTotalSpace() -             store.getUnallocatedSpace()) / 1024;long avail = store.getUsableSpace() / 1024;

TheDiskUsage example uses this API to print disk space information for all the stores in the default file system. This example uses thegetFileStores method in theFileSystem class to fetch all the file stores for the file system.