DefaultProjectFilesystem (Buck)

java.lang.Object
- com.facebook.buck.io.filesystem.impl.DefaultProjectFilesystem

All Implemented Interfaces:

ProjectFilesystem, Cloneable
```
public class DefaultProjectFilesystem
extends Object
implements Cloneable, ProjectFilesystem
```
An injectable service for interacting with the filesystem relative to the project root.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean ignoreValidityOfPaths

Fields
Modifier and Type	Field and Description
`protected boolean`	`ignoreValidityOfPaths`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DefaultProjectFilesystem(AbsPath root, com.google.common.collect.ImmutableSet<PathMatcher> blackListedPaths, BuckPaths buckPaths, ProjectFilesystemDelegate delegate, ProjectFilesystemDelegatePair delegatePair, WindowsFS winFSInstance)`
	`DefaultProjectFilesystem(AbsPath root, com.google.common.collect.ImmutableSet<PathMatcher> blackListedPaths, BuckPaths buckPaths, ProjectFilesystemDelegate delegate, WindowsFS winFSInstance)`
`protected`	`DefaultProjectFilesystem(CanonicalCellName cellName, AbsPath root, ProjectFilesystemDelegate delegate, WindowsFS winFSInstance, boolean buckOutIncludeTargetConfigHash)` This function should be only used in tests, because it ignores hashes-in-path buckconfig.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultProjectFilesystemView`	`asView()`
`DefaultProjectFilesystem`	`clone()`
`Sha1HashCode`	`computeSha1(Path pathRelativeToProjectRootOrJustAbsolute)`
`String`	`computeSha256(Path pathRelativeToProjectRoot)`
`void`	`copy(Path source, Path target, CopySourceMode sourceMode)`
`void`	`copyFile(Path source, Path target)`
`void`	`copyFolder(Path source, Path target)`
`void`	`copyToOutputStream(Path pathRelativeToProjectRoot, OutputStream out)` Copies a file to an output stream.
`void`	`copyToPath(InputStream inputStream, Path pathRelativeToProjectRoot, CopyOption... options)`
`DefaultProjectFilesystem`	`createBuckOutProjectFilesystem()`
`Path`	`createNewFile(Path pathRelativeToProjectRoot)` Creates a new file relative to the project root.
`void`	`createParentDirs(Path pathRelativeToProjectRoot)`
`void`	`createParentDirs(String pathRelativeToProjectRoot)` // @deprecated Prefer operating on `Path`s directly, replaced by `createParentDirs(java.nio.file.Path)`.
`void`	`createSymLink(Path symLink, Path realFile, boolean force)`
`Path`	`createTempFile(Path directory, String prefix, String suffix, FileAttribute<?>... attrs)` Prefer `createTempFile(String, String, FileAttribute[])` so that temporary files are guaranteed to be created under `buck-out`.
`Path`	`createTempFile(String prefix, String suffix, FileAttribute<?>... attrs)` Returns a relative path whose parent directory is guaranteed to exist.
`void`	`deleteFileAtPath(Path pathRelativeToProjectRoot)` Deletes a file specified by its path relative to the project root.
`boolean`	`deleteFileAtPathIfExists(Path pathRelativeToProjectRoot)` Deletes a file specified by its path relative to the project root.
`void`	`deleteRecursivelyIfExists(Path pathRelativeToProjectRoot)` Recursively delete everything under the specified path.
`boolean`	`equals(Object other)`
`boolean`	`exists(Path pathRelativeToProjectRoot, LinkOption... options)`
`com.google.common.collect.ImmutableSet<PathMatcher>`	`getBlacklistedPaths()`
`BuckPaths`	`getBuckPaths()`
`static Path`	`getCacheDir(Path root, Optional<String> value, BuckPaths buckPaths)`
`com.google.common.collect.ImmutableMap<String,? extends Object>`	`getDelegateDetails()`
`com.google.common.collect.ImmutableCollection<Path>`	`getDirectoryContents(Path pathToUse)` Use `ProjectFilesystemView.getDirectoryContents(Path)` instead
`long`	`getFileAttributesForZipEntry(Path path)` getFileAttributesForZipEntry is similar to getPosixFileMode, but returns a number adjusted for use in zip files.
`long`	`getFileSize(Path pathRelativeToProjectRoot)`
`com.google.common.collect.ImmutableSet<Path>`	`getFilesUnderPath(Path pathRelativeToProjectRoot)` Use `ProjectFilesystemView.getFilesUnderPath(Path, EnumSet)` instead
`com.google.common.collect.ImmutableSet<Path>`	`getFilesUnderPath(Path pathRelativeToProjectRoot, java.util.function.Predicate<Path> predicate)` Use `ProjectFilesystemView.getFilesUnderPath(Path, com.google.common.base.Predicate, EnumSet)` instead
`com.google.common.collect.ImmutableSet<Path>`	`getFilesUnderPath(Path pathRelativeToProjectRoot, java.util.function.Predicate<Path> predicate, EnumSet<FileVisitOption> visitOptions)` Use `ProjectFilesystemView.getFilesUnderPath(Path, com.google.common.base.Predicate, EnumSet)` instead
`com.google.common.collect.ImmutableSet<PathMatcher>`	`getIgnorePaths()`
`InputStream`	`getInputStreamForRelativePath(Path path)` // @deprecated Prefer operation on `Path`s directly, replaced by `Files.newInputStream(java.nio.file.Path, java.nio.file.OpenOption...)`.
`Manifest`	`getJarManifest(Path path)`
`FileTime`	`getLastModifiedTime(Path pathRelativeToProjectRoot)`
`protected PathListing.PathModifiedTimeFetcher`	`getLastModifiedTimeFetcher()`
`com.google.common.collect.ImmutableSortedSet<Path>`	`getMtimeSortedMatchingDirectoryContents(Path pathRelativeToProjectRoot, String globPattern)` Returns the files inside `pathRelativeToProjectRoot` which match `globPattern`, ordered in descending last modified time order.
`Path`	`getPath(String first, String... rest)` Converts a path string (or sequence of strings) to a Path with the same VFS as this instance.
`Path`	`getPathForRelativeExistingPath(Path pathRelativeToProjectRoot)` As `getPathForRelativePath(java.nio.file.Path)`, but with the added twist that the existence of the path is checked before returning.
`Path`	`getPathForRelativePath(Path pathRelativeToProjectRoot)`
`Path`	`getPathForRelativePath(String pathRelativeToProjectRoot)`
`Optional<Path>`	`getPathRelativeToProjectRoot(Path path)`
`long`	`getPosixFileMode(Path path)` getPosixFileMode returns a number corresponding to stat()'s ST_MODE, for use when constructing tar archives.
`Set<PosixFilePermission>`	`getPosixFilePermissions(Path path)` Returns the set of POSIX file permissions, or the empty set if the underlying file system does not support POSIX file attributes.
`AbsPath`	`getRootPath()`
`int`	`hashCode()`
`boolean`	`isDirectory(Path child, LinkOption... linkOptions)` Allows `Files.isDirectory(java.nio.file.Path, java.nio.file.LinkOption...)` to be faked in tests.
`boolean`	`isExecutable(Path child)` Allows `Files.isExecutable(java.nio.file.Path)` to be faked in tests.
`boolean`	`isFile(Path pathRelativeToProjectRoot, LinkOption... options)` Checks whether there is a normal file at the specified path.
`boolean`	`isHidden(Path pathRelativeToProjectRoot)`
`boolean`	`isIgnored(RelPath path)` Use `ProjectFilesystemView.isIgnored(Path)` instead
`boolean`	`isSymLink(Path path)` Returns true if the file under `path` exists and is a symbolic link, false otherwise.
`void`	`mergeChildren(Path source, Path target, CopyOption... options)` Moves the children of `source` into `target`, merging the two directories.
`void`	`mkdirs(Path pathRelativeToProjectRoot)` Resolves the relative path against the project root and then calls `Files.createDirectories(java.nio.file.Path, java.nio.file.attribute.FileAttribute[])`
`void`	`move(Path source, Path target, CopyOption... options)`
`InputStream`	`newFileInputStream(Path pathRelativeToProjectRoot)`
`OutputStream`	`newFileOutputStream(Path pathRelativeToProjectRoot, boolean append, FileAttribute<?>... attrs)`
`OutputStream`	`newFileOutputStream(Path pathRelativeToProjectRoot, FileAttribute<?>... attrs)`
`OutputStream`	`newUnbufferedFileOutputStream(Path pathRelativeToProjectRoot, boolean append, FileAttribute<?>... attrs)`
`<A extends BasicFileAttributes> A`	`readAttributes(Path pathRelativeToProjectRoot, Class<A> type, LinkOption... options)`
`Optional<String>`	`readFileIfItExists(Path pathRelativeToProjectRoot)`
`Optional<String>`	`readFirstLine(Path pathRelativeToProjectRoot)` Attempts to read the first line of the file specified by the relative path.
`Optional<String>`	`readFirstLine(String pathRelativeToProjectRoot)` Attempts to read the first line of the file specified by the relative path.
`Optional<String>`	`readFirstLineFromFile(Path file)` Attempts to read the first line of the specified file.
`List<String>`	`readLines(Path pathRelativeToProjectRoot)`
`Properties`	`readPropertiesFile(Path propertiesFile)`
`Path`	`readSymLink(Path path)` Returns the target of the specified symbolic link.
`RelPath`	`relativize(Path path)` Construct a relative path between the project root and a given path.
`Path`	`resolve(Path path)`
`Path`	`resolve(String path)`
`Path`	`setLastModifiedTime(Path pathRelativeToProjectRoot, FileTime time)` Sets the last modified time for the given path.
`protected boolean`	`shouldVerifyConstructorArguments()` For testing purposes, subclasses might want to skip some of the verification done by the constructor on its arguments.
`String`	`toString()`
`void`	`touch(Path fileToTouch)`
`protected DefaultProjectFilesystem`	`useBuckOutProjectDelegate()`
`void`	`walkFileTree(Path root, FileVisitor<Path> fileVisitor)` Allows `Files.walkFileTree(java.nio.file.Path, java.util.Set<java.nio.file.FileVisitOption>, int, java.nio.file.FileVisitor<? super java.nio.file.Path>)` to be faked in tests.
`void`	`walkFileTree(Path root, Set<FileVisitOption> options, FileVisitor<Path> fileVisitor)` Use `ProjectFilesystemView.walkFileTree(Path, Set, FileVisitor)` instead
`void`	`walkRelativeFileTree(Path pathRelativeToProjectRoot, EnumSet<FileVisitOption> visitOptions, FileVisitor<Path> fileVisitor, boolean skipIgnored)` Walks a project-root relative file tree with a visitor and visit options.
`void`	`walkRelativeFileTree(Path pathRelativeToProjectRoot, FileVisitor<Path> fileVisitor)` Similar to `walkFileTree(Path, FileVisitor)` except this takes in a path relative to the project root.
`void`	`walkRelativeFileTree(Path pathRelativeToProjectRoot, FileVisitor<Path> fileVisitor, boolean skipIgnored)` Similar to `ProjectFilesystem.walkFileTree(Path, FileVisitor)` except this takes in a path relative to the project root.
`void`	`writeBytesToPath(byte[] bytes, Path pathRelativeToProjectRoot, FileAttribute<?>... attrs)`
`void`	`writeContentsToPath(String contents, Path pathRelativeToProjectRoot, FileAttribute<?>... attrs)`
`void`	`writeLinesToPath(Iterable<String> lines, Path pathRelativeToProjectRoot, FileAttribute<?>... attrs)` Writes each line in `lines` with a trailing newline to a file at the specified path.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.io.filesystem.ProjectFilesystem
createSymLink, exists, exists, getFileSystem, isDirectory, isFile, newFileInputStream, relativize, resolve, resolve

Field Detail

ignoreValidityOfPaths

protected boolean ignoreValidityOfPaths

Constructor Detail

DefaultProjectFilesystem

protected DefaultProjectFilesystem(CanonicalCellName cellName,
                                   AbsPath root,
                                   ProjectFilesystemDelegate delegate,
                                   @Nullable
                                   WindowsFS winFSInstance,
                                   boolean buckOutIncludeTargetConfigHash)

This function should be only used in tests, because it ignores hashes-in-path buckconfig.

DefaultProjectFilesystem

public DefaultProjectFilesystem(AbsPath root,
                                com.google.common.collect.ImmutableSet<PathMatcher> blackListedPaths,
                                BuckPaths buckPaths,
                                ProjectFilesystemDelegate delegate,
                                @Nullable
                                WindowsFS winFSInstance)

DefaultProjectFilesystem

public DefaultProjectFilesystem(AbsPath root,
                                com.google.common.collect.ImmutableSet<PathMatcher> blackListedPaths,
                                BuckPaths buckPaths,
                                ProjectFilesystemDelegate delegate,
                                ProjectFilesystemDelegatePair delegatePair,
                                @Nullable
                                WindowsFS winFSInstance)

Method Detail
- shouldVerifyConstructorArguments
```
protected boolean shouldVerifyConstructorArguments()
```
  For testing purposes, subclasses might want to skip some of the verification done by the constructor on its arguments.
- getCacheDir
```
public static Path getCacheDir(Path root,
                               Optional<String> value,
                               BuckPaths buckPaths)
```
- clone
```
public DefaultProjectFilesystem clone()
                               throws CloneNotSupportedException
```
  Overrides:
  
  clone in class Object
  
  Throws:
  
  CloneNotSupportedException
- useBuckOutProjectDelegate
```
protected DefaultProjectFilesystem useBuckOutProjectDelegate()
```
- createBuckOutProjectFilesystem
```
public DefaultProjectFilesystem createBuckOutProjectFilesystem()
```
  Specified by:
  
  createBuckOutProjectFilesystem in interface ProjectFilesystem
- asView
```
public DefaultProjectFilesystemView asView()
```
  Specified by:
  
  asView in interface ProjectFilesystem
  
  Returns:
  
  the default view over this project filesystem, where the view root is the project root, and no ignored paths.
- getRootPath
```
public final AbsPath getRootPath()
```
  Specified by:
  
  getRootPath in interface ProjectFilesystem
- getDelegateDetails
```
public com.google.common.collect.ImmutableMap<String,? extends Object> getDelegateDetails()
```
  Specified by:
  
  getDelegateDetails in interface ProjectFilesystem
  
  Returns:
  
  details about the delegate suitable for writing to a logger. It is recommended that the keys of this map are unique in namespace of the things a logger may want to log. Values must be String, int, or boolean.
- resolve
```
public Path resolve(Path path)
```
  Specified by:
  
  resolve in interface ProjectFilesystem
  
  Returns:
  
  the specified path resolved against getRootPath() to an absolute path.
- resolve
```
public Path resolve(String path)
```
  Specified by:
  
  resolve in interface ProjectFilesystem
- relativize
```
public RelPath relativize(Path path)
```
  Construct a relative path between the project root and a given path.
  
  Specified by:
  
  relativize in interface ProjectFilesystem
- getBlacklistedPaths
```
public com.google.common.collect.ImmutableSet<PathMatcher> getBlacklistedPaths()
```
  Specified by:
  
  getBlacklistedPaths in interface ProjectFilesystem
  
  Returns:
  
  a set of PathMatcher objects ignored by ProjectFilesystem.isIgnored(RelPath)
- getIgnorePaths
```
public com.google.common.collect.ImmutableSet<PathMatcher> getIgnorePaths()
```
  Specified by:
  
  getIgnorePaths in interface ProjectFilesystem
  
  Returns:
  
  A ImmutableSet of PathMatcher objects to have buck ignore.
- getPathForRelativePath
```
public Path getPathForRelativePath(Path pathRelativeToProjectRoot)
```
  Specified by:
  
  getPathForRelativePath in interface ProjectFilesystem
- getPathForRelativePath
```
public Path getPathForRelativePath(String pathRelativeToProjectRoot)
```
  Specified by:
  
  getPathForRelativePath in interface ProjectFilesystem
- getPathRelativeToProjectRoot
```
public Optional<Path> getPathRelativeToProjectRoot(Path path)
```
  Specified by:
  
  getPathRelativeToProjectRoot in interface ProjectFilesystem
  
  Parameters:
  
  path - Absolute path or path relative to the project root.
  
  Returns:
  
  If path is relative, it is returned. If it is absolute and is inside the project root, it is relativized to the project root and returned. Otherwise an absent value is returned.
- getPathForRelativeExistingPath
```
public Path getPathForRelativeExistingPath(Path pathRelativeToProjectRoot)
```
  As getPathForRelativePath(java.nio.file.Path), but with the added twist that the existence of the path is checked before returning.
  
  Specified by:
  
  getPathForRelativeExistingPath in interface ProjectFilesystem
- exists
```
public boolean exists(Path pathRelativeToProjectRoot,
                      LinkOption... options)
```
  Specified by:
  
  exists in interface ProjectFilesystem
- getFileSize
```
public long getFileSize(Path pathRelativeToProjectRoot)
                 throws IOException
```
  Specified by:
  
  getFileSize in interface ProjectFilesystem
  
  Throws:
  
  IOException
- deleteFileAtPathIfExists
```
public boolean deleteFileAtPathIfExists(Path pathRelativeToProjectRoot)
                                 throws IOException
```
  Deletes a file specified by its path relative to the project root.
  Ignores the failure if the file does not exist.
  
  Specified by:
  
  deleteFileAtPathIfExists in interface ProjectFilesystem
  
  Parameters:
  
  pathRelativeToProjectRoot - path to the file
  
  Returns:
  
  true if the file was deleted, false if it did not exist
  
  Throws:
  
  IOException
- deleteFileAtPath
```
public void deleteFileAtPath(Path pathRelativeToProjectRoot)
                      throws IOException
```
  Deletes a file specified by its path relative to the project root.
  
  Specified by:
  
  deleteFileAtPath in interface ProjectFilesystem
  
  Parameters:
  
  pathRelativeToProjectRoot - path to the file
  
  Throws:
  
  IOException
- readPropertiesFile
```
public Properties readPropertiesFile(Path propertiesFile)
                              throws IOException
```
  Specified by:
  
  readPropertiesFile in interface ProjectFilesystem
  
  Throws:
  
  IOException
- isFile
```
public boolean isFile(Path pathRelativeToProjectRoot,
                      LinkOption... options)
```
  Checks whether there is a normal file at the specified path.
  
  Specified by:
  
  isFile in interface ProjectFilesystem
- isHidden
```
public boolean isHidden(Path pathRelativeToProjectRoot)
                 throws IOException
```
  Specified by:
  
  isHidden in interface ProjectFilesystem
  
  Throws:
  
  IOException
- walkRelativeFileTree
```
public void walkRelativeFileTree(Path pathRelativeToProjectRoot,
                                 FileVisitor<Path> fileVisitor)
                          throws IOException
```
  Similar to walkFileTree(Path, FileVisitor) except this takes in a path relative to the project root.
  
  Specified by:
  
  walkRelativeFileTree in interface ProjectFilesystem
  
  Throws:
  
  IOException
- walkRelativeFileTree
```
public void walkRelativeFileTree(Path pathRelativeToProjectRoot,
                                 FileVisitor<Path> fileVisitor,
                                 boolean skipIgnored)
                          throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  Similar to ProjectFilesystem.walkFileTree(Path, FileVisitor) except this takes in a path relative to the project root.
  This is deprecated. Please use ProjectFilesystemView.walkRelativeFileTree(Path, EnumSet, FileVisitor) instead.
  
  Specified by:
  
  walkRelativeFileTree in interface ProjectFilesystem
  
  Throws:
  
  IOException
- walkRelativeFileTree
```
public void walkRelativeFileTree(Path pathRelativeToProjectRoot,
                                 EnumSet<FileVisitOption> visitOptions,
                                 FileVisitor<Path> fileVisitor,
                                 boolean skipIgnored)
                          throws IOException
```
  Walks a project-root relative file tree with a visitor and visit options.
  
  Specified by:
  
  walkRelativeFileTree in interface ProjectFilesystem
  
  Throws:
  
  IOException
- walkFileTree
```
public void walkFileTree(Path root,
                         FileVisitor<Path> fileVisitor)
                  throws IOException
```
  Allows Files.walkFileTree(java.nio.file.Path, java.util.Set<java.nio.file.FileVisitOption>, int, java.nio.file.FileVisitor<? super java.nio.file.Path>) to be faked in tests.
  
  Specified by:
  
  walkFileTree in interface ProjectFilesystem
  
  Throws:
  
  IOException
- walkFileTree
```
public void walkFileTree(Path root,
                         Set<FileVisitOption> options,
                         FileVisitor<Path> fileVisitor)
                  throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  Use ProjectFilesystemView.walkFileTree(Path, Set, FileVisitor) instead
  
  Specified by:
  
  walkFileTree in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getFilesUnderPath
```
public com.google.common.collect.ImmutableSet<Path> getFilesUnderPath(Path pathRelativeToProjectRoot)
                                                               throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  Use ProjectFilesystemView.getFilesUnderPath(Path, EnumSet) instead
  
  Specified by:
  
  getFilesUnderPath in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getFilesUnderPath
```
public com.google.common.collect.ImmutableSet<Path> getFilesUnderPath(Path pathRelativeToProjectRoot,
                                                                      java.util.function.Predicate<Path> predicate)
                                                               throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  Use ProjectFilesystemView.getFilesUnderPath(Path, com.google.common.base.Predicate, EnumSet) instead
  
  Specified by:
  
  getFilesUnderPath in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getFilesUnderPath
```
public com.google.common.collect.ImmutableSet<Path> getFilesUnderPath(Path pathRelativeToProjectRoot,
                                                                      java.util.function.Predicate<Path> predicate,
                                                                      EnumSet<FileVisitOption> visitOptions)
                                                               throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  Use ProjectFilesystemView.getFilesUnderPath(Path, com.google.common.base.Predicate, EnumSet) instead
  
  Specified by:
  
  getFilesUnderPath in interface ProjectFilesystem
  
  Throws:
  
  IOException
- isDirectory
```
public boolean isDirectory(Path child,
                           LinkOption... linkOptions)
```
  Allows Files.isDirectory(java.nio.file.Path, java.nio.file.LinkOption...) to be faked in tests.
  
  Specified by:
  
  isDirectory in interface ProjectFilesystem
- isExecutable
```
public boolean isExecutable(Path child)
```
  Allows Files.isExecutable(java.nio.file.Path) to be faked in tests.
  
  Specified by:
  
  isExecutable in interface ProjectFilesystem
- getDirectoryContents
```
public com.google.common.collect.ImmutableCollection<Path> getDirectoryContents(Path pathToUse)
                                                                         throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  Use ProjectFilesystemView.getDirectoryContents(Path) instead
  
  Specified by:
  
  getDirectoryContents in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getLastModifiedTimeFetcher
```
protected PathListing.PathModifiedTimeFetcher getLastModifiedTimeFetcher()
```
- getMtimeSortedMatchingDirectoryContents
```
public com.google.common.collect.ImmutableSortedSet<Path> getMtimeSortedMatchingDirectoryContents(Path pathRelativeToProjectRoot,
                                                                                                  String globPattern)
                                                                                           throws IOException
```
  Returns the files inside pathRelativeToProjectRoot which match globPattern, ordered in descending last modified time order. This will not obey the results of ProjectFilesystem.isIgnored(RelPath).
  
  Specified by:
  
  getMtimeSortedMatchingDirectoryContents in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getLastModifiedTime
```
public FileTime getLastModifiedTime(Path pathRelativeToProjectRoot)
                             throws IOException
```
  Specified by:
  
  getLastModifiedTime in interface ProjectFilesystem
  
  Throws:
  
  IOException
- setLastModifiedTime
```
public Path setLastModifiedTime(Path pathRelativeToProjectRoot,
                                FileTime time)
                         throws IOException
```
  Sets the last modified time for the given path.
  
  Specified by:
  
  setLastModifiedTime in interface ProjectFilesystem
  
  Throws:
  
  IOException
- deleteRecursivelyIfExists
```
public void deleteRecursivelyIfExists(Path pathRelativeToProjectRoot)
                               throws IOException
```
  Recursively delete everything under the specified path. Ignore the failure if the file at the specified path does not exist.
  
  Specified by:
  
  deleteRecursivelyIfExists in interface ProjectFilesystem
  
  Throws:
  
  IOException
- mkdirs
```
public void mkdirs(Path pathRelativeToProjectRoot)
            throws IOException
```
  Resolves the relative path against the project root and then calls Files.createDirectories(java.nio.file.Path, java.nio.file.attribute.FileAttribute[])
  
  Specified by:
  
  mkdirs in interface ProjectFilesystem
  
  Throws:
  
  IOException
- createNewFile
```
public Path createNewFile(Path pathRelativeToProjectRoot)
                   throws IOException
```
  Creates a new file relative to the project root.
  
  Specified by:
  
  createNewFile in interface ProjectFilesystem
  
  Throws:
  
  IOException
- createParentDirs
```
public void createParentDirs(String pathRelativeToProjectRoot)
                      throws IOException
```
  // @deprecated Prefer operating on Paths directly, replaced by createParentDirs(java.nio.file.Path).
  
  Specified by:
  
  createParentDirs in interface ProjectFilesystem
  
  Throws:
  
  IOException
- createParentDirs
```
public void createParentDirs(Path pathRelativeToProjectRoot)
                      throws IOException
```
  Specified by:
  
  createParentDirs in interface ProjectFilesystem
  
  Parameters:
  
  pathRelativeToProjectRoot - Must identify a file, not a directory. (Unfortunately, we have no way to assert this because the path is not expected to exist yet.)
  
  Throws:
  
  IOException
- writeLinesToPath
```
public void writeLinesToPath(Iterable<String> lines,
                             Path pathRelativeToProjectRoot,
                             FileAttribute<?>... attrs)
                      throws IOException
```
  Writes each line in lines with a trailing newline to a file at the specified path.
  The parent path of pathRelativeToProjectRoot must exist.
  
  Specified by:
  
  writeLinesToPath in interface ProjectFilesystem
  
  Throws:
  
  IOException
- writeContentsToPath
```
public void writeContentsToPath(String contents,
                                Path pathRelativeToProjectRoot,
                                FileAttribute<?>... attrs)
                         throws IOException
```
  Specified by:
  
  writeContentsToPath in interface ProjectFilesystem
  
  Throws:
  
  IOException
- writeBytesToPath
```
public void writeBytesToPath(byte[] bytes,
                             Path pathRelativeToProjectRoot,
                             FileAttribute<?>... attrs)
                      throws IOException
```
  Specified by:
  
  writeBytesToPath in interface ProjectFilesystem
  
  Throws:
  
  IOException
- newFileOutputStream
```
public OutputStream newFileOutputStream(Path pathRelativeToProjectRoot,
                                        FileAttribute<?>... attrs)
                                 throws IOException
```
  Specified by:
  
  newFileOutputStream in interface ProjectFilesystem
  
  Throws:
  
  IOException
- newFileOutputStream
```
public OutputStream newFileOutputStream(Path pathRelativeToProjectRoot,
                                        boolean append,
                                        FileAttribute<?>... attrs)
                                 throws IOException
```
  Specified by:
  
  newFileOutputStream in interface ProjectFilesystem
  
  Throws:
  
  IOException
- newUnbufferedFileOutputStream
```
public OutputStream newUnbufferedFileOutputStream(Path pathRelativeToProjectRoot,
                                                  boolean append,
                                                  FileAttribute<?>... attrs)
                                           throws IOException
```
  Specified by:
  
  newUnbufferedFileOutputStream in interface ProjectFilesystem
  
  Throws:
  
  IOException
- readAttributes
```
public <A extends BasicFileAttributes> A readAttributes(Path pathRelativeToProjectRoot,
                                                        Class<A> type,
                                                        LinkOption... options)
                                                 throws IOException
```
  Specified by:
  
  readAttributes in interface ProjectFilesystem
  
  Throws:
  
  IOException
- newFileInputStream
```
public InputStream newFileInputStream(Path pathRelativeToProjectRoot)
                               throws IOException
```
  Specified by:
  
  newFileInputStream in interface ProjectFilesystem
  
  Throws:
  
  IOException
- copyToPath
```
public void copyToPath(InputStream inputStream,
                       Path pathRelativeToProjectRoot,
                       CopyOption... options)
                throws IOException
```
  Specified by:
  
  copyToPath in interface ProjectFilesystem
  
  Parameters:
  
  inputStream - Source of the bytes. This method does not close this stream.
  
  Throws:
  
  IOException
- copyToOutputStream
```
public void copyToOutputStream(Path pathRelativeToProjectRoot,
                               OutputStream out)
                        throws IOException
```
  Copies a file to an output stream.
  
  Specified by:
  
  copyToOutputStream in interface ProjectFilesystem
  
  Throws:
  
  IOException
- readFileIfItExists
```
public Optional<String> readFileIfItExists(Path pathRelativeToProjectRoot)
```
  Specified by:
  
  readFileIfItExists in interface ProjectFilesystem
- readFirstLine
```
public Optional<String> readFirstLine(String pathRelativeToProjectRoot)
```
  Attempts to read the first line of the file specified by the relative path. If the file does not exist, is empty, or encounters an error while being read, Optional.empty() is returned. Otherwise, an Optional with the first line of the file will be returned.
  // @deprecated PRefero operation on Paths directly, replaced by readFirstLine(java.nio.file.Path)
  
  Specified by:
  
  readFirstLine in interface ProjectFilesystem
- readFirstLine
```
public Optional<String> readFirstLine(Path pathRelativeToProjectRoot)
```
  Attempts to read the first line of the file specified by the relative path. If the file does not exist, is empty, or encounters an error while being read, Optional.empty() is returned. Otherwise, an Optional with the first line of the file will be returned.
  
  Specified by:
  
  readFirstLine in interface ProjectFilesystem
- readFirstLineFromFile
```
public Optional<String> readFirstLineFromFile(Path file)
```
  Attempts to read the first line of the specified file. If the file does not exist, is empty, or encounters an error while being read, Optional.empty() is returned. Otherwise, an Optional with the first line of the file will be returned.
  
  Specified by:
  
  readFirstLineFromFile in interface ProjectFilesystem
- readLines
```
public List<String> readLines(Path pathRelativeToProjectRoot)
                       throws IOException
```
  Specified by:
  
  readLines in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getInputStreamForRelativePath
```
public InputStream getInputStreamForRelativePath(Path path)
                                          throws IOException
```
  // @deprecated Prefer operation on Paths directly, replaced by Files.newInputStream(java.nio.file.Path, java.nio.file.OpenOption...).
  
  Specified by:
  
  getInputStreamForRelativePath in interface ProjectFilesystem
  
  Throws:
  
  IOException
- computeSha1
```
public Sha1HashCode computeSha1(Path pathRelativeToProjectRootOrJustAbsolute)
                         throws IOException
```
  Specified by:
  
  computeSha1 in interface ProjectFilesystem
  
  Throws:
  
  IOException
- computeSha256
```
public String computeSha256(Path pathRelativeToProjectRoot)
                     throws IOException
```
  Specified by:
  
  computeSha256 in interface ProjectFilesystem
  
  Throws:
  
  IOException
- copy
```
public void copy(Path source,
                 Path target,
                 CopySourceMode sourceMode)
          throws IOException
```
  Specified by:
  
  copy in interface ProjectFilesystem
  
  Throws:
  
  IOException
- move
```
public void move(Path source,
                 Path target,
                 CopyOption... options)
          throws IOException
```
  Specified by:
  
  move in interface ProjectFilesystem
  
  Throws:
  
  IOException
- mergeChildren
```
public void mergeChildren(Path source,
                          Path target,
                          CopyOption... options)
                   throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  Moves the children of source into target, merging the two directories.
  
  Specified by:
  
  mergeChildren in interface ProjectFilesystem
  
  Throws:
  
  IOException
- copyFolder
```
public void copyFolder(Path source,
                       Path target)
                throws IOException
```
  Specified by:
  
  copyFolder in interface ProjectFilesystem
  
  Throws:
  
  IOException
- copyFile
```
public void copyFile(Path source,
                     Path target)
              throws IOException
```
  Specified by:
  
  copyFile in interface ProjectFilesystem
  
  Throws:
  
  IOException
- createSymLink
```
public void createSymLink(Path symLink,
                          Path realFile,
                          boolean force)
                   throws IOException
```
  Specified by:
  
  createSymLink in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getPosixFilePermissions
```
public Set<PosixFilePermission> getPosixFilePermissions(Path path)
                                                 throws IOException
```
  Returns the set of POSIX file permissions, or the empty set if the underlying file system does not support POSIX file attributes.
  
  Specified by:
  
  getPosixFilePermissions in interface ProjectFilesystem
  
  Throws:
  
  IOException
- isSymLink
```
public boolean isSymLink(Path path)
```
  Returns true if the file under path exists and is a symbolic link, false otherwise.
  
  Specified by:
  
  isSymLink in interface ProjectFilesystem
- readSymLink
```
public Path readSymLink(Path path)
                 throws IOException
```
  Returns the target of the specified symbolic link.
  
  Specified by:
  
  readSymLink in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getJarManifest
```
public Manifest getJarManifest(Path path)
                        throws IOException
```
  Specified by:
  
  getJarManifest in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getPosixFileMode
```
public long getPosixFileMode(Path path)
                      throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  getPosixFileMode returns a number corresponding to stat()'s ST_MODE, for use when constructing tar archives.
  
  Specified by:
  
  getPosixFileMode in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getFileAttributesForZipEntry
```
public long getFileAttributesForZipEntry(Path path)
                                  throws IOException
```
  Description copied from interface: ProjectFilesystem
  
  getFileAttributesForZipEntry is similar to getPosixFileMode, but returns a number adjusted for use in zip files.
  
  Specified by:
  
  getFileAttributesForZipEntry in interface ProjectFilesystem
  
  Throws:
  
  IOException
- equals
```
public boolean equals(Object other)
```
  Overrides:
  
  equals in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- getBuckPaths
```
public BuckPaths getBuckPaths()
```
  Specified by:
  
  getBuckPaths in interface ProjectFilesystem
- isIgnored
```
public boolean isIgnored(RelPath path)
```
  Description copied from interface: ProjectFilesystem
  
  Use ProjectFilesystemView.isIgnored(Path) instead
  
  Specified by:
  
  isIgnored in interface ProjectFilesystem
  
  Parameters:
  
  path - the path to check.
  
  Returns:
  
  whether ignoredPaths contains path or any of its ancestors.
- createTempFile
```
public Path createTempFile(String prefix,
                           String suffix,
                           FileAttribute<?>... attrs)
                    throws IOException
```
  Returns a relative path whose parent directory is guaranteed to exist. The path will be under buck-out, so it is safe to write to.
  
  Specified by:
  
  createTempFile in interface ProjectFilesystem
  
  Throws:
  
  IOException
- createTempFile
```
public Path createTempFile(Path directory,
                           String prefix,
                           String suffix,
                           FileAttribute<?>... attrs)
                    throws IOException
```
  Prefer createTempFile(String, String, FileAttribute[]) so that temporary files are guaranteed to be created under buck-out. This method will be deprecated once t12079608 is resolved.
  
  Specified by:
  
  createTempFile in interface ProjectFilesystem
  
  Throws:
  
  IOException
- touch
```
public void touch(Path fileToTouch)
           throws IOException
```
  Specified by:
  
  touch in interface ProjectFilesystem
  
  Throws:
  
  IOException
- getPath
```
public Path getPath(String first,
                    String... rest)
```
  Converts a path string (or sequence of strings) to a Path with the same VFS as this instance.
  
  Specified by:
  
  getPath in interface ProjectFilesystem
  
  See Also:
  
  FileSystem.getPath(String, String...)

Class DefaultProjectFilesystem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.facebook.buck.io.filesystem.ProjectFilesystem

Field Detail

ignoreValidityOfPaths

Constructor Detail

DefaultProjectFilesystem

DefaultProjectFilesystem

DefaultProjectFilesystem

Method Detail

shouldVerifyConstructorArguments

getCacheDir

clone

useBuckOutProjectDelegate

createBuckOutProjectFilesystem

asView

getRootPath

getDelegateDetails

resolve

resolve

relativize

getBlacklistedPaths

getIgnorePaths

getPathForRelativePath

getPathForRelativePath

getPathRelativeToProjectRoot

getPathForRelativeExistingPath

exists

getFileSize

deleteFileAtPathIfExists

deleteFileAtPath

readPropertiesFile

isFile

isHidden

walkRelativeFileTree

walkRelativeFileTree

walkRelativeFileTree

walkFileTree

walkFileTree

getFilesUnderPath

getFilesUnderPath

getFilesUnderPath

isDirectory

isExecutable

getDirectoryContents

getLastModifiedTimeFetcher

getMtimeSortedMatchingDirectoryContents

getLastModifiedTime

setLastModifiedTime

deleteRecursivelyIfExists

mkdirs

createNewFile

createParentDirs

createParentDirs

writeLinesToPath

writeContentsToPath

writeBytesToPath

newFileOutputStream

newFileOutputStream

newUnbufferedFileOutputStream

readAttributes

newFileInputStream

copyToPath

copyToOutputStream

readFileIfItExists

readFirstLine

readFirstLine

readFirstLineFromFile

readLines

getInputStreamForRelativePath

computeSha1

computeSha256

copy

move

mergeChildren

copyFolder

copyFile