Uses of Interface java.nio.file.Path (Java Platform SE 7 b138)

Packages that use Path
Package	Description
java.io	Provides for system input and output through data streams, serialization and the file system.
java.nio.channels	Defines channels, which represent connections to entities that are capable of performing I/O operations, such as files and sockets; defines selectors, for multiplexed, non-blocking I/O operations.
java.nio.file	Defines interfaces and classes for the Java virtual machine to access files, file attributes, and file systems.
java.nio.file.spi	Service-provider classes for the `java.nio.file` package.
java.util	Contains the collections framework, legacy collection classes, event model, date and time facilities, internationalization, and miscellaneous utility classes (a string tokenizer, a random-number generator, and a bit array).

Uses of Path in java.io

Methods in java.io that return Path
Modifier and Type Method and Description

Path File.toPath()
Returns a java.nio.file.Path object constructed from the this abstract path.

Methods in java.io that return Path
Modifier and Type	Method and Description
`Path`	File.`toPath()` Returns a `java.nio.file.Path` object constructed from the this abstract path.

Uses of Path in java.nio.channels

Methods in java.nio.channels with parameters of type Path
Modifier and Type	Method and Description
`static AsynchronousFileChannel`	AsynchronousFileChannel.`open(Path file, OpenOption... options)` Opens or creates a file for reading and/or writing, returning an asynchronous file channel to access the file.
`static FileChannel`	FileChannel.`open(Path path, OpenOption... options)` Opens or creates a file, returning a file channel to access the file.
`static AsynchronousFileChannel`	AsynchronousFileChannel.`open(Path file, Set<? extends OpenOption> options, ExecutorService executor, FileAttribute<?>... attrs)` Opens or creates a file for reading and/or writing, returning an asynchronous file channel to access the file.
`static FileChannel`	FileChannel.`open(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)` Opens or creates a file, returning a file channel to access the file.

Uses of Path in java.nio.file

Fields in java.nio.file with type parameters of type Path
Modifier and Type	Field and Description
`static WatchEvent.Kind<Path>`	StandardWatchEventKind.`ENTRY_CREATE` Directory entry created.
`static WatchEvent.Kind<Path>`	StandardWatchEventKind.`ENTRY_DELETE` Directory entry deleted.
`static WatchEvent.Kind<Path>`	StandardWatchEventKind.`ENTRY_MODIFY` Directory entry modified.

Methods in java.nio.file that return Path
Modifier and Type	Method and Description
`static Path`	Files.`copy(Path source, Path target, CopyOption... options)` Copy a file to a target file.
`static Path`	Files.`createDirectories(Path dir, FileAttribute<?>... attrs)` Creates a directory by creating all nonexistent parent directories first.
`static Path`	Files.`createDirectory(Path dir, FileAttribute<?>... attrs)` Creates a new directory.
`static Path`	Files.`createFile(Path path, FileAttribute<?>... attrs)` Creates a new and empty file, failing if the file already exists.
`static Path`	Files.`createLink(Path link, Path existing)` Creates a new link (directory entry) for an existing file (optional operation).
`static Path`	Files.`createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)` Creates a symbolic link to a target (optional operation).
`static Path`	Files.`createTempDirectory(Path dir, String prefix, FileAttribute<?>... attrs)` Creates a new directory in the specified directory, using the given prefix to generate its name.
`static Path`	Files.`createTempDirectory(String prefix, FileAttribute<?>... attrs)` Creates a new directory in the default temporary-file directory, using the given prefix to generate its name.
`static Path`	Files.`createTempFile(Path dir, String prefix, String suffix, FileAttribute<?>... attrs)` Creates a new empty file in the specified directory, using the given prefix and suffix strings to generate its name.
`static Path`	Files.`createTempFile(String prefix, String suffix, FileAttribute<?>... attrs)` Creates an empty file in the default temporary-file directory, using the given prefix and suffix to generate its name.
`static Path`	Paths.`get(String first, String... more)` Converts a path string, or a sequence of strings that when joined form a path string, to a `Path`.
`static Path`	Paths.`get(URI uri)` Converts the given URI to a `Path` object.
`Path`	Path.`getFileName()` Returns the name of the file or directory denoted by this path as a `Path` object.
`Path`	Path.`getName(int index)` Returns a name element of this path as a `Path` object.
`Path`	Path.`getParent()` Returns the parent path, or `null` if this path does not have a parent.
`abstract Path`	FileSystem.`getPath(String first, String... more)` Converts a path string, or a sequence of strings that when joined form a path string, to a `Path`.
`Path`	Path.`getRoot()` Returns the root component of this path as a `Path` object, or `null` if this path does not have a root component.
`static Path`	Files.`move(Path source, Path target, CopyOption... options)` Move or rename a file to a target file.
`Path`	Path.`normalize()` Returns a path that is this path with redundant name elements eliminated.
`static Path`	Files.`readSymbolicLink(Path link)` Reads the target of a symbolic link (optional operation).
`Path`	Path.`relativize(Path other)` Constructs a relative path between this path and a given path.
`Path`	Path.`resolve(Path other)` Resolve the given path against this path.
`Path`	Path.`resolve(String other)` Converts a given path string to a `Path` and resolves it against this `Path` in exactly the manner specified by the `resolve` method.
`Path`	Path.`resolveSibling(Path other)` Resolves the given path against this path's `parent` path.
`Path`	Path.`resolveSibling(String other)` Converts a given path string to a `Path` and resolves it against this path's `parent` path in exactly the manner specified by the `resolveSibling` method.
`static Path`	Files.`setAttribute(Path path, String attribute, Object value, LinkOption... options)` Sets the value of a file attribute.
`static Path`	Files.`setLastModifiedTime(Path path, FileTime time)` Updates a file's last modified time attribute.
`static Path`	Files.`setOwner(Path path, UserPrincipal owner)` Updates the file owner.
`static Path`	Files.`setPosixFilePermissions(Path path, Set<PosixFilePermission> perms)` Sets a file's POSIX permissions.
`Path`	Path.`subpath(int beginIndex, int endIndex)` Returns a relative `Path` that is a subsequence of the name elements of this path.
`Path`	Path.`toAbsolutePath()` Returns a `Path` object representing the absolute path of this path.
`Path`	Path.`toRealPath(LinkOption... options)` Returns the real path of an existing file.
`static Path`	Files.`walkFileTree(Path start, FileVisitor<? super Path> visitor)` Walks a file tree.
`static Path`	Files.`walkFileTree(Path start, Set<FileVisitOption> options, int maxDepth, FileVisitor<? super Path> visitor)` Walks a file tree.
`static Path`	Files.`write(Path path, byte[] bytes, OpenOption... options)` Writes bytes to a file.
`static Path`	Files.`write(Path path, Iterable<? extends CharSequence> lines, Charset cs, OpenOption... options)` Write lines of text to a file.

Methods in java.nio.file that return types with arguments of type Path
Modifier and Type	Method and Description
`abstract Iterable<Path>`	FileSystem.`getRootDirectories()` Returns an object to iterate over the paths of the root directories.
`Iterator<Path>`	Path.`iterator()` Returns an iterator over the name elements of this path.
`static DirectoryStream<Path>`	Files.`newDirectoryStream(Path dir)` Opens a directory, returning a `DirectoryStream` to iterate over all entries in the directory.
`static DirectoryStream<Path>`	Files.`newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)` Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.
`static DirectoryStream<Path>`	Files.`newDirectoryStream(Path dir, String glob)` Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.

Methods in java.nio.file with parameters of type Path
Modifier and Type	Method and Description
`int`	Path.`compareTo(Path other)` Compares two abstract paths lexicographically.
`static long`	Files.`copy(InputStream in, Path target, CopyOption... options)` Copies all bytes from an input stream to a file.
`static long`	Files.`copy(Path source, OutputStream out)` Copies all bytes from a file to an output stream.
`static Path`	Files.`copy(Path source, Path target, CopyOption... options)` Copy a file to a target file.
`static Path`	Files.`createDirectories(Path dir, FileAttribute<?>... attrs)` Creates a directory by creating all nonexistent parent directories first.
`static Path`	Files.`createDirectory(Path dir, FileAttribute<?>... attrs)` Creates a new directory.
`static Path`	Files.`createFile(Path path, FileAttribute<?>... attrs)` Creates a new and empty file, failing if the file already exists.
`static Path`	Files.`createLink(Path link, Path existing)` Creates a new link (directory entry) for an existing file (optional operation).
`static Path`	Files.`createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)` Creates a symbolic link to a target (optional operation).
`static Path`	Files.`createTempDirectory(Path dir, String prefix, FileAttribute<?>... attrs)` Creates a new directory in the specified directory, using the given prefix to generate its name.
`static Path`	Files.`createTempFile(Path dir, String prefix, String suffix, FileAttribute<?>... attrs)` Creates a new empty file in the specified directory, using the given prefix and suffix strings to generate its name.
`static void`	Files.`delete(Path path)` Deletes a file.
`static boolean`	Files.`deleteIfExists(Path path)` Deletes a file if it exists.
`boolean`	Path.`endsWith(Path other)` Tests if this path ends with the given path.
`static boolean`	Files.`exists(Path path, LinkOption... options)` Tests whether a file exists.
`static Object`	Files.`getAttribute(Path path, String attribute, LinkOption... options)` Reads the value of a file attribute.
`static <V extends FileAttributeView> V`	Files.`getFileAttributeView(Path path, Class<V> type, LinkOption... options)` Returns a file attribute view of a given type.
`static FileStore`	Files.`getFileStore(Path path)` Returns the `FileStore` representing the file store where a file is located.
`static FileTime`	Files.`getLastModifiedTime(Path path, LinkOption... options)` Returns a file's last modified time.
`static UserPrincipal`	Files.`getOwner(Path path, LinkOption... options)` Returns the owner of a file.
`static Set<PosixFilePermission>`	Files.`getPosixFilePermissions(Path path, LinkOption... options)` Returns a file's POSIX file permissions.
`static boolean`	Files.`isDirectory(Path path, LinkOption... options)` Tests whether a file is a directory.
`static boolean`	Files.`isExecutable(Path path)` Tests whether a file is executable.
`static boolean`	Files.`isHidden(Path path)` Tells whether or not a file is considered hidden.
`static boolean`	Files.`isReadable(Path path)` Tests whether a file is readable.
`static boolean`	Files.`isRegularFile(Path path, LinkOption... options)` Tests whether a file is a regular file with opaque content.
`static boolean`	Files.`isSameFile(Path path, Path path2)` Tests if two paths locate the same file.
`static boolean`	Files.`isSymbolicLink(Path path)` Tests whether a file is a symbolic link.
`static boolean`	Files.`isWritable(Path path)` Tests whether a file is writable.
`boolean`	PathMatcher.`matches(Path path)` Tells if given path matches this matcher's pattern.
`static Path`	Files.`move(Path source, Path target, CopyOption... options)` Move or rename a file to a target file.
`static BufferedReader`	Files.`newBufferedReader(Path path, Charset cs)` Opens a file for reading, returning a `BufferedReader` that may be used to read text from the file in an efficient manner.
`static BufferedWriter`	Files.`newBufferedWriter(Path path, Charset cs, OpenOption... options)` Opens or creates a file for writing, returning a `BufferedWriter` that may be used to write text to the file in an efficient manner.
`static SeekableByteChannel`	Files.`newByteChannel(Path path, OpenOption... options)` Opens or creates a file, returning a seekable byte channel to access the file.
`static SeekableByteChannel`	Files.`newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)` Opens or creates a file, returning a seekable byte channel to access the file.
`static DirectoryStream<Path>`	Files.`newDirectoryStream(Path dir)` Opens a directory, returning a `DirectoryStream` to iterate over all entries in the directory.
`static DirectoryStream<Path>`	Files.`newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)` Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.
`static DirectoryStream<Path>`	Files.`newDirectoryStream(Path dir, String glob)` Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.
`static FileSystem`	FileSystems.`newFileSystem(Path path, ClassLoader loader)` Constructs a new `FileSystem` to access the contents of a file as a file system.
`static InputStream`	Files.`newInputStream(Path path, OpenOption... options)` Opens a file, returning an input stream to read from the file.
`static OutputStream`	Files.`newOutputStream(Path path, OpenOption... options)` Opens or creates a file, returning an output stream that may be used to write bytes to the file.
`static boolean`	Files.`notExists(Path path, LinkOption... options)` Tests whether the file located by this path does not exist.
`static String`	Files.`probeContentType(Path path)` Probes the content type of a file.
`static byte[]`	Files.`readAllBytes(Path path)` Read all the bytes from a file.
`static List<String>`	Files.`readAllLines(Path path, Charset cs)` Read all lines from a file.
`static <A extends BasicFileAttributes> A`	Files.`readAttributes(Path path, Class<A> type, LinkOption... options)` Reads a file's attributes as a bulk operation.
`static Map<String,Object>`	Files.`readAttributes(Path path, String attributes, LinkOption... options)` Reads a set of file attributes as a bulk operation.
`static Path`	Files.`readSymbolicLink(Path link)` Reads the target of a symbolic link (optional operation).
`Path`	Path.`relativize(Path other)` Constructs a relative path between this path and a given path.
`Path`	Path.`resolve(Path other)` Resolve the given path against this path.
`Path`	Path.`resolveSibling(Path other)` Resolves the given path against this path's `parent` path.
`static Path`	Files.`setAttribute(Path path, String attribute, Object value, LinkOption... options)` Sets the value of a file attribute.
`static Path`	Files.`setLastModifiedTime(Path path, FileTime time)` Updates a file's last modified time attribute.
`static Path`	Files.`setOwner(Path path, UserPrincipal owner)` Updates the file owner.
`static Path`	Files.`setPosixFilePermissions(Path path, Set<PosixFilePermission> perms)` Sets a file's POSIX permissions.
`static long`	Files.`size(Path path)` Returns the size of a file (in bytes).
`boolean`	Path.`startsWith(Path other)` Tests if this path starts with the given path.
`static Path`	Files.`walkFileTree(Path start, FileVisitor<? super Path> visitor)` Walks a file tree.
`static Path`	Files.`walkFileTree(Path start, Set<FileVisitOption> options, int maxDepth, FileVisitor<? super Path> visitor)` Walks a file tree.
`static Path`	Files.`write(Path path, byte[] bytes, OpenOption... options)` Writes bytes to a file.
`static Path`	Files.`write(Path path, Iterable<? extends CharSequence> lines, Charset cs, OpenOption... options)` Write lines of text to a file.

Method parameters in java.nio.file with type arguments of type Path
Modifier and Type	Method and Description
`static DirectoryStream<Path>`	Files.`newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)` Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.
`static Path`	Files.`walkFileTree(Path start, FileVisitor<? super Path> visitor)` Walks a file tree.
`static Path`	Files.`walkFileTree(Path start, Set<FileVisitOption> options, int maxDepth, FileVisitor<? super Path> visitor)` Walks a file tree.

Uses of Path in java.nio.file.spi

Methods in java.nio.file.spi that return Path
Modifier and Type	Method and Description
`abstract Path`	FileSystemProvider.`getPath(URI uri)` Return a `Path` object by converting the given `URI`.
`Path`	FileSystemProvider.`readSymbolicLink(Path link)` Reads the target of a symbolic link.

Methods in java.nio.file.spi that return types with arguments of type Path
Modifier and Type	Method and Description
`abstract DirectoryStream<Path>`	FileSystemProvider.`newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)` Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.

Methods in java.nio.file.spi with parameters of type Path
Modifier and Type	Method and Description
`abstract void`	FileSystemProvider.`checkAccess(Path path, AccessMode... modes)` Checks the existence, and optionally the accessibility, of a file.
`abstract void`	FileSystemProvider.`copy(Path source, Path target, CopyOption... options)` Copy a file to a target file.
`abstract void`	FileSystemProvider.`createDirectory(Path dir, FileAttribute<?>... attrs)` Creates a new directory.
`void`	FileSystemProvider.`createLink(Path link, Path existing)` Creates a new link (directory entry) for an existing file.
`void`	FileSystemProvider.`createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)` Creates a symbolic link to a target.
`abstract void`	FileSystemProvider.`delete(Path path)` Deletes a file.
`boolean`	FileSystemProvider.`deleteIfExists(Path path)` Deletes a file if it exists.
`abstract <V extends FileAttributeView> V`	FileSystemProvider.`getFileAttributeView(Path path, Class<V> type, LinkOption... options)` Returns a file attribute view of a given type.
`abstract FileStore`	FileSystemProvider.`getFileStore(Path path)` Returns the `FileStore` representing the file store where a file is located.
`abstract boolean`	FileSystemProvider.`isHidden(Path path)` Tells whether or not a file is considered hidden.
`abstract boolean`	FileSystemProvider.`isSameFile(Path path, Path path2)` Tests if two paths locate the same file.
`abstract void`	FileSystemProvider.`move(Path source, Path target, CopyOption... options)` Move or rename a file to a target file.
`AsynchronousFileChannel`	FileSystemProvider.`newAsynchronousFileChannel(Path path, Set<? extends OpenOption> options, ExecutorService executor, FileAttribute<?>... attrs)` Opens or creates a file for reading and/or writing, returning an asynchronous file channel to access the file.
`abstract SeekableByteChannel`	FileSystemProvider.`newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)` Opens or creates a file, returning a seekable byte channel to access the file.
`abstract DirectoryStream<Path>`	FileSystemProvider.`newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)` Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.
`FileChannel`	FileSystemProvider.`newFileChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)` Opens or creates a file for reading and/or writing, returning a file channel to access the file.
`FileSystem`	FileSystemProvider.`newFileSystem(Path path, Map<String,?> env)` Constructs a new `FileSystem` to access the contents of a file as a file system.
`InputStream`	FileSystemProvider.`newInputStream(Path path, OpenOption... options)` Opens a file, returning an input stream to read from the file.
`OutputStream`	FileSystemProvider.`newOutputStream(Path path, OpenOption... options)` Opens or creates a file, returning an output stream that may be used to write bytes to the file.
`abstract String`	FileTypeDetector.`probeContentType(Path path)` Probes the given file to guess its content type.
`abstract <A extends BasicFileAttributes> A`	FileSystemProvider.`readAttributes(Path path, Class<A> type, LinkOption... options)` Reads a file's attributes as a bulk operation.
`abstract Map<String,Object>`	FileSystemProvider.`readAttributes(Path path, String attributes, LinkOption... options)` Reads a set of file attributes as a bulk operation.
`Path`	FileSystemProvider.`readSymbolicLink(Path link)` Reads the target of a symbolic link.
`abstract void`	FileSystemProvider.`setAttribute(Path path, String attribute, Object value, LinkOption... options)` Sets the value of a file attribute.

Method parameters in java.nio.file.spi with type arguments of type Path
Modifier and Type	Method and Description
`abstract DirectoryStream<Path>`	FileSystemProvider.`newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)` Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.

Uses of Path in java.util

Constructors in java.util with parameters of type Path
Constructor and Description
`Scanner(Path source)` Constructs a new `Scanner` that produces values scanned from the specified file.
`Scanner(Path source, String charsetName)` Constructs a new `Scanner` that produces values scanned from the specified file.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138

Uses of Interfacejava.nio.file.Path

Uses of Path in java.io

Uses of Path in java.nio.channels

Uses of Path in java.nio.file

Uses of Path in java.nio.file.spi

Uses of Path in java.util

Uses of Interface
java.nio.file.Path