Uses of Interface
java.nio.file.Path
-
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 thejava.nio.filepackage.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 PathFile. toPath()Returns ajava.nio.file.Pathobject 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 AsynchronousFileChannelAsynchronousFileChannel. 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 FileChannelFileChannel. open(Path path, OpenOption... options)Opens or creates a file, returning a file channel to access the file.static AsynchronousFileChannelAsynchronousFileChannel. 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 FileChannelFileChannel. 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>StandardWatchEventKinds. ENTRY_CREATEDirectory entry created.static WatchEvent.Kind<Path>StandardWatchEventKinds. ENTRY_DELETEDirectory entry deleted.static WatchEvent.Kind<Path>StandardWatchEventKinds. ENTRY_MODIFYDirectory entry modified.Methods in java.nio.file that return Path Modifier and Type Method and Description static PathFiles. copy(Path source, Path target, CopyOption... options)Copy a file to a target file.static PathFiles. createDirectories(Path dir, FileAttribute<?>... attrs)Creates a directory by creating all nonexistent parent directories first.static PathFiles. createDirectory(Path dir, FileAttribute<?>... attrs)Creates a new directory.static PathFiles. createFile(Path path, FileAttribute<?>... attrs)Creates a new and empty file, failing if the file already exists.static PathFiles. createLink(Path link, Path existing)Creates a new link (directory entry) for an existing file (optional operation).static PathFiles. createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)Creates a symbolic link to a target (optional operation).static PathFiles. createTempDirectory(Path dir, String prefix, FileAttribute<?>... attrs)Creates a new directory in the specified directory, using the given prefix to generate its name.static PathFiles. createTempDirectory(String prefix, FileAttribute<?>... attrs)Creates a new directory in the default temporary-file directory, using the given prefix to generate its name.static PathFiles. 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 PathFiles. 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 PathPaths. get(String first, String... more)Converts a path string, or a sequence of strings that when joined form a path string, to aPath.static PathPaths. get(URI uri)Converts the given URI to aPathobject.PathPath. getFileName()Returns the name of the file or directory denoted by this path as aPathobject.PathPath. getName(int index)Returns a name element of this path as aPathobject.PathPath. getParent()Returns the parent path, ornullif this path does not have a parent.abstract PathFileSystem. getPath(String first, String... more)Converts a path string, or a sequence of strings that when joined form a path string, to aPath.PathPath. getRoot()Returns the root component of this path as aPathobject, ornullif this path does not have a root component.static PathFiles. move(Path source, Path target, CopyOption... options)Move or rename a file to a target file.PathPath. normalize()Returns a path that is this path with redundant name elements eliminated.static PathFiles. readSymbolicLink(Path link)Reads the target of a symbolic link (optional operation).PathPath. relativize(Path other)Constructs a relative path between this path and a given path.PathPath. resolve(Path other)Resolve the given path against this path.PathPath. resolve(String other)Converts a given path string to aPathand resolves it against thisPathin exactly the manner specified by theresolvemethod.PathPath. resolveSibling(Path other)Resolves the given path against this path'sparentpath.PathPath. resolveSibling(String other)Converts a given path string to aPathand resolves it against this path'sparentpath in exactly the manner specified by theresolveSiblingmethod.static PathFiles. setAttribute(Path path, String attribute, Object value, LinkOption... options)Sets the value of a file attribute.static PathFiles. setLastModifiedTime(Path path, FileTime time)Updates a file's last modified time attribute.static PathFiles. setOwner(Path path, UserPrincipal owner)Updates the file owner.static PathFiles. setPosixFilePermissions(Path path, Set<PosixFilePermission> perms)Sets a file's POSIX permissions.PathPath. subpath(int beginIndex, int endIndex)Returns a relativePaththat is a subsequence of the name elements of this path.PathPath. toAbsolutePath()Returns aPathobject representing the absolute path of this path.PathPath. toRealPath(LinkOption... options)Returns the real path of an existing file.static PathFiles. walkFileTree(Path start, FileVisitor<? super Path> visitor)Walks a file tree.static PathFiles. walkFileTree(Path start, Set<FileVisitOption> options, int maxDepth, FileVisitor<? super Path> visitor)Walks a file tree.static PathFiles. write(Path path, byte[] bytes, OpenOption... options)Writes bytes to a file.static PathFiles. write(Path path, Iterable<? extends CharSequence> lines, Charset cs, OpenOption... options)Write lines of text to a file.static PathFiles. write(Path path, Iterable<? extends CharSequence> lines, 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 static Stream<Path>Files. find(Path start, int maxDepth, BiPredicate<Path,BasicFileAttributes> matcher, FileVisitOption... options)Return aStreamthat is lazily populated withPathby searching for files in a file tree rooted at a given starting file.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 Stream<Path>Files. list(Path dir)Return a lazily populatedStream, the elements of which are the entries in the directory.static DirectoryStream<Path>Files. newDirectoryStream(Path dir)Opens a directory, returning aDirectoryStreamto iterate over all entries in the directory.static DirectoryStream<Path>Files. newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)Opens a directory, returning aDirectoryStreamto iterate over the entries in the directory.static DirectoryStream<Path>Files. newDirectoryStream(Path dir, String glob)Opens a directory, returning aDirectoryStreamto iterate over the entries in the directory.static Stream<Path>Files. walk(Path start, FileVisitOption... options)Return aStreamthat is lazily populated withPathby walking the file tree rooted at a given starting file.static Stream<Path>Files. walk(Path start, int maxDepth, FileVisitOption... options)Return aStreamthat is lazily populated withPathby walking the file tree rooted at a given starting file.Methods in java.nio.file with parameters of type Path Modifier and Type Method and Description intPath. compareTo(Path other)Compares two abstract paths lexicographically.static longFiles. copy(InputStream in, Path target, CopyOption... options)Copies all bytes from an input stream to a file.static longFiles. copy(Path source, OutputStream out)Copies all bytes from a file to an output stream.static PathFiles. copy(Path source, Path target, CopyOption... options)Copy a file to a target file.static PathFiles. createDirectories(Path dir, FileAttribute<?>... attrs)Creates a directory by creating all nonexistent parent directories first.static PathFiles. createDirectory(Path dir, FileAttribute<?>... attrs)Creates a new directory.static PathFiles. createFile(Path path, FileAttribute<?>... attrs)Creates a new and empty file, failing if the file already exists.static PathFiles. createLink(Path link, Path existing)Creates a new link (directory entry) for an existing file (optional operation).static PathFiles. createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)Creates a symbolic link to a target (optional operation).static PathFiles. createTempDirectory(Path dir, String prefix, FileAttribute<?>... attrs)Creates a new directory in the specified directory, using the given prefix to generate its name.static PathFiles. 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 voidFiles. delete(Path path)Deletes a file.static booleanFiles. deleteIfExists(Path path)Deletes a file if it exists.booleanPath. endsWith(Path other)Tests if this path ends with the given path.static booleanFiles. exists(Path path, LinkOption... options)Tests whether a file exists.static Stream<Path>Files. find(Path start, int maxDepth, BiPredicate<Path,BasicFileAttributes> matcher, FileVisitOption... options)Return aStreamthat is lazily populated withPathby searching for files in a file tree rooted at a given starting file.static ObjectFiles. getAttribute(Path path, String attribute, LinkOption... options)Reads the value of a file attribute.static <V extends FileAttributeView>
VFiles. getFileAttributeView(Path path, Class<V> type, LinkOption... options)Returns a file attribute view of a given type.static FileStoreFiles. getFileStore(Path path)Returns theFileStorerepresenting the file store where a file is located.static FileTimeFiles. getLastModifiedTime(Path path, LinkOption... options)Returns a file's last modified time.static UserPrincipalFiles. 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 booleanFiles. isDirectory(Path path, LinkOption... options)Tests whether a file is a directory.static booleanFiles. isExecutable(Path path)Tests whether a file is executable.static booleanFiles. isHidden(Path path)Tells whether or not a file is considered hidden.static booleanFiles. isReadable(Path path)Tests whether a file is readable.static booleanFiles. isRegularFile(Path path, LinkOption... options)Tests whether a file is a regular file with opaque content.static booleanFiles. isSameFile(Path path, Path path2)Tests if two paths locate the same file.static booleanFiles. isSymbolicLink(Path path)Tests whether a file is a symbolic link.static booleanFiles. isWritable(Path path)Tests whether a file is writable.static Stream<String>Files. lines(Path path)Read all lines from a file as aStream.static Stream<String>Files. lines(Path path, Charset cs)Read all lines from a file as aStream.static Stream<Path>Files. list(Path dir)Return a lazily populatedStream, the elements of which are the entries in the directory.booleanPathMatcher. matches(Path path)Tells if given path matches this matcher's pattern.static PathFiles. move(Path source, Path target, CopyOption... options)Move or rename a file to a target file.static BufferedReaderFiles. newBufferedReader(Path path)Opens a file for reading, returning aBufferedReaderto read text from the file in an efficient manner.static BufferedReaderFiles. newBufferedReader(Path path, Charset cs)Opens a file for reading, returning aBufferedReaderthat may be used to read text from the file in an efficient manner.static BufferedWriterFiles. newBufferedWriter(Path path, Charset cs, OpenOption... options)Opens or creates a file for writing, returning aBufferedWriterthat may be used to write text to the file in an efficient manner.static BufferedWriterFiles. newBufferedWriter(Path path, OpenOption... options)Opens or creates a file for writing, returning aBufferedWriterto write text to the file in an efficient manner.static SeekableByteChannelFiles. newByteChannel(Path path, OpenOption... options)Opens or creates a file, returning a seekable byte channel to access the file.static SeekableByteChannelFiles. 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 aDirectoryStreamto iterate over all entries in the directory.static DirectoryStream<Path>Files. newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)Opens a directory, returning aDirectoryStreamto iterate over the entries in the directory.static DirectoryStream<Path>Files. newDirectoryStream(Path dir, String glob)Opens a directory, returning aDirectoryStreamto iterate over the entries in the directory.static FileSystemFileSystems. newFileSystem(Path path, ClassLoader loader)Constructs a newFileSystemto access the contents of a file as a file system.static InputStreamFiles. newInputStream(Path path, OpenOption... options)Opens a file, returning an input stream to read from the file.static OutputStreamFiles. 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 booleanFiles. notExists(Path path, LinkOption... options)Tests whether the file located by this path does not exist.static StringFiles. probeContentType(Path path)Probes the content type of a file.static byte[]Files. readAllBytes(Path path)Reads all the bytes from a file.static List<String>Files. readAllLines(Path path)Read all lines from a file.static List<String>Files. readAllLines(Path path, Charset cs)Read all lines from a file.static <A extends BasicFileAttributes>
AFiles. 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 PathFiles. readSymbolicLink(Path link)Reads the target of a symbolic link (optional operation).PathPath. relativize(Path other)Constructs a relative path between this path and a given path.PathPath. resolve(Path other)Resolve the given path against this path.PathPath. resolveSibling(Path other)Resolves the given path against this path'sparentpath.static PathFiles. setAttribute(Path path, String attribute, Object value, LinkOption... options)Sets the value of a file attribute.static PathFiles. setLastModifiedTime(Path path, FileTime time)Updates a file's last modified time attribute.static PathFiles. setOwner(Path path, UserPrincipal owner)Updates the file owner.static PathFiles. setPosixFilePermissions(Path path, Set<PosixFilePermission> perms)Sets a file's POSIX permissions.static longFiles. size(Path path)Returns the size of a file (in bytes).booleanPath. startsWith(Path other)Tests if this path starts with the given path.static Stream<Path>Files. walk(Path start, FileVisitOption... options)Return aStreamthat is lazily populated withPathby walking the file tree rooted at a given starting file.static Stream<Path>Files. walk(Path start, int maxDepth, FileVisitOption... options)Return aStreamthat is lazily populated withPathby walking the file tree rooted at a given starting file.static PathFiles. walkFileTree(Path start, FileVisitor<? super Path> visitor)Walks a file tree.static PathFiles. walkFileTree(Path start, Set<FileVisitOption> options, int maxDepth, FileVisitor<? super Path> visitor)Walks a file tree.static PathFiles. write(Path path, byte[] bytes, OpenOption... options)Writes bytes to a file.static PathFiles. write(Path path, Iterable<? extends CharSequence> lines, Charset cs, OpenOption... options)Write lines of text to a file.static PathFiles. write(Path path, Iterable<? extends CharSequence> lines, 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 Stream<Path>Files. find(Path start, int maxDepth, BiPredicate<Path,BasicFileAttributes> matcher, FileVisitOption... options)Return aStreamthat is lazily populated withPathby searching for files in a file tree rooted at a given starting file.static DirectoryStream<Path>Files. newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)Opens a directory, returning aDirectoryStreamto iterate over the entries in the directory.static PathFiles. walkFileTree(Path start, FileVisitor<? super Path> visitor)Walks a file tree.static PathFiles. 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 PathFileSystemProvider. getPath(URI uri)Return aPathobject by converting the givenURI.PathFileSystemProvider. 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 aDirectoryStreamto 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 voidFileSystemProvider. checkAccess(Path path, AccessMode... modes)Checks the existence, and optionally the accessibility, of a file.abstract voidFileSystemProvider. copy(Path source, Path target, CopyOption... options)Copy a file to a target file.abstract voidFileSystemProvider. createDirectory(Path dir, FileAttribute<?>... attrs)Creates a new directory.voidFileSystemProvider. createLink(Path link, Path existing)Creates a new link (directory entry) for an existing file.voidFileSystemProvider. createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)Creates a symbolic link to a target.abstract voidFileSystemProvider. delete(Path path)Deletes a file.booleanFileSystemProvider. deleteIfExists(Path path)Deletes a file if it exists.abstract <V extends FileAttributeView>
VFileSystemProvider. getFileAttributeView(Path path, Class<V> type, LinkOption... options)Returns a file attribute view of a given type.abstract FileStoreFileSystemProvider. getFileStore(Path path)Returns theFileStorerepresenting the file store where a file is located.abstract booleanFileSystemProvider. isHidden(Path path)Tells whether or not a file is considered hidden.abstract booleanFileSystemProvider. isSameFile(Path path, Path path2)Tests if two paths locate the same file.abstract voidFileSystemProvider. move(Path source, Path target, CopyOption... options)Move or rename a file to a target file.AsynchronousFileChannelFileSystemProvider. 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 SeekableByteChannelFileSystemProvider. 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 aDirectoryStreamto iterate over the entries in the directory.FileChannelFileSystemProvider. 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.FileSystemFileSystemProvider. newFileSystem(Path path, Map<String,?> env)Constructs a newFileSystemto access the contents of a file as a file system.InputStreamFileSystemProvider. newInputStream(Path path, OpenOption... options)Opens a file, returning an input stream to read from the file.OutputStreamFileSystemProvider. 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 StringFileTypeDetector. probeContentType(Path path)Probes the given file to guess its content type.abstract <A extends BasicFileAttributes>
AFileSystemProvider. 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.PathFileSystemProvider. readSymbolicLink(Path link)Reads the target of a symbolic link.abstract voidFileSystemProvider. 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 aDirectoryStreamto 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 newScannerthat produces values scanned from the specified file.Scanner(Path source, String charsetName)Constructs a newScannerthat 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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
