com.facebook.buck.io.filesystem.impl

Class DefaultProjectFilesystemView

java.lang.Object

com.facebook.buck.io.filesystem.impl.DefaultProjectFilesystemView

All Implemented Interfaces:

ProjectFilesystemView

public class DefaultProjectFilesystemView
extends Object
implements ProjectFilesystemView

A ProjectFilesystemView for the DefaultProjectFilesystem

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableCollection<Path>	getDirectoryContents(Path pathToUse) Gets a list of paths of the contents of the given directory, obeying the ignores.
com.google.common.collect.ImmutableSet<Path>	getFilesUnderPath(Path pathRelativeToProjectRoot, EnumSet<FileVisitOption> visitOptions)
com.google.common.collect.ImmutableSet<Path>	getFilesUnderPath(Path pathRelativeToProjectRoot, com.google.common.base.Predicate<Path> filter, EnumSet<FileVisitOption> visitOptions) Returns a list of files under the given path relative to the root of this view, filtered both blacklist and the given filter.
Path	getRootPath()
boolean	isDirectory(Path path)
boolean	isFile(Path path, LinkOption... options) Checks whether there is a normal file at the specified path
boolean	isIgnored(Path path)
boolean	isSubdirOf(Path path)
<A extends BasicFileAttributes> A	readAttributes(Path path, Class<A> type, LinkOption... options) Read basic attributes of a file from a file system
Path	relativize(Path path)
Path	resolve(ForwardRelativePath path)
Path	resolve(Path path)
Path	resolve(String path)
com.google.common.collect.ImmutableList<String>	toWatchmanQuery(Set<Capability> capabilities)
void	walkFileTree(Path pathRelativeToProjectRoot, Set<FileVisitOption> options, FileVisitor<Path> fileVisitor) Walks the filesystem starting at a given path relative to the root of this view, and all paths give to fileVisitor is absolute
void	walkRelativeFileTree(Path pathRelativeToProjectRoot, EnumSet<FileVisitOption> visitOptions, FileVisitor<Path> fileVisitor) Similar to ProjectFilesystemView.walkFileTree(Path, Set, FileVisitor) fileVisitor receives paths relative to the root of this view
DefaultProjectFilesystemView	withView(Path newRelativeRoot, com.google.common.collect.ImmutableSet<PathMatcher> additionalIgnores)
void	writeLinesToPath(Iterable<String> lines, Path path, FileAttribute<?>... attrs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

toWatchmanQuery

public com.google.common.collect.ImmutableList<String> toWatchmanQuery(Set<Capability> capabilities)

Specified by:

toWatchmanQuery in interface ProjectFilesystemView

isSubdirOf

public boolean isSubdirOf(Path path)

Specified by:

isSubdirOf in interface ProjectFilesystemView

Parameters:

path - an absolute path

Returns:

true if path is a subdirectory of the root

relativize

public Path relativize(Path path)

Specified by:

relativize in interface ProjectFilesystemView

Parameters:

path - an absolute path to relativize

Returns:

a relative path from the path root of this view to the given path

resolve

public Path resolve(Path path)

Specified by:

resolve in interface ProjectFilesystemView

Parameters:

path - the relative path to resolve

Returns:

an absolute path of the given path relative to the root of this view

resolve

public Path resolve(String path)

Specified by:

resolve in interface ProjectFilesystemView

See Also:

ProjectFilesystemView.resolve(Path)

resolve

public Path resolve(ForwardRelativePath path)

Specified by:

resolve in interface ProjectFilesystemView

See Also:

ProjectFilesystemView.resolve(Path)

isFile

public boolean isFile(Path path,
                      LinkOption... options)

Description copied from interface: ProjectFilesystemView

Checks whether there is a normal file at the specified path

Specified by:

isFile in interface ProjectFilesystemView

Parameters:

path - relative path to the root

options - whether to resolve symlinks

Returns:

true if path is a file

isDirectory

public boolean isDirectory(Path path)

Specified by:

isDirectory in interface ProjectFilesystemView

Parameters:

path - relative path to the root

Returns:

true iff the given path maps to a directory

readAttributes

public <A extends BasicFileAttributes> A readAttributes(Path path,
                                                        Class<A> type,
                                                        LinkOption... options)
                                                 throws IOException

Description copied from interface: ProjectFilesystemView

Read basic attributes of a file from a file system

Specified by:

readAttributes in interface ProjectFilesystemView

Parameters:

path - relative path to the root

type - type of attributes object

options - whether to resolve symlinks

Returns:

File attributes object

Throws:

IOException

getRootPath

public Path getRootPath()

Specified by:

getRootPath in interface ProjectFilesystemView

Returns:

the absolute path of the root of this view

withView

public DefaultProjectFilesystemView withView(Path newRelativeRoot,
                                             com.google.common.collect.ImmutableSet<PathMatcher> additionalIgnores)

Specified by:

withView in interface ProjectFilesystemView

Parameters:

newRelativeRoot - the new root relative to the current root

additionalIgnores - new ignored paths in addition to the current ignores

Returns:

a new View based on the current view

isIgnored

public boolean isIgnored(Path path)

Specified by:

isIgnored in interface ProjectFilesystemView

Parameters:

path - an relative paths to the root of this filesystem view

Returns:

whether the path is ignored by this view

walkRelativeFileTree

public void walkRelativeFileTree(Path pathRelativeToProjectRoot,
                                 EnumSet<FileVisitOption> visitOptions,
                                 FileVisitor<Path> fileVisitor)
                          throws IOException

Description copied from interface: ProjectFilesystemView

Similar to ProjectFilesystemView.walkFileTree(Path, Set, FileVisitor) fileVisitor receives paths relative to the root of this view

Specified by:

walkRelativeFileTree in interface ProjectFilesystemView

Throws:

IOException

walkFileTree

public void walkFileTree(Path pathRelativeToProjectRoot,
                         Set<FileVisitOption> options,
                         FileVisitor<Path> fileVisitor)
                  throws IOException

Description copied from interface: ProjectFilesystemView

Walks the filesystem starting at a given path relative to the root of this view, and all paths give to fileVisitor is absolute

Specified by:

walkFileTree in interface ProjectFilesystemView

Throws:

IOException

getFilesUnderPath

public com.google.common.collect.ImmutableSet<Path> getFilesUnderPath(Path pathRelativeToProjectRoot,
                                                                      EnumSet<FileVisitOption> visitOptions)
                                                               throws IOException

Specified by:

getFilesUnderPath in interface ProjectFilesystemView

Throws:

IOException

getFilesUnderPath

public com.google.common.collect.ImmutableSet<Path> getFilesUnderPath(Path pathRelativeToProjectRoot,
                                                                      com.google.common.base.Predicate<Path> filter,
                                                                      EnumSet<FileVisitOption> visitOptions)
                                                               throws IOException

Description copied from interface: ProjectFilesystemView

Returns a list of files under the given path relative to the root of this view, filtered both blacklist and the given filter. The returned paths are also relative to the root of this view.

Specified by:

getFilesUnderPath in interface ProjectFilesystemView

Throws:

IOException

getDirectoryContents

public com.google.common.collect.ImmutableCollection<Path> getDirectoryContents(Path pathToUse)
                                                                         throws IOException

Description copied from interface: ProjectFilesystemView

Gets a list of paths of the contents of the given directory, obeying the ignores. All paths are relative to the root of this view.

Specified by:

getDirectoryContents in interface ProjectFilesystemView

Throws:

IOException

writeLinesToPath

public void writeLinesToPath(Iterable<String> lines,
                             Path path,
                             FileAttribute<?>... attrs)
                      throws IOException

Specified by:

writeLinesToPath in interface ProjectFilesystemView

Parameters:

lines - the lines to write to the file. Each item is written as one line

path - the path relative to the view of this root to write the file. The parent of the path must exist

attrs - the FileAttributes for the file created

Throws:

IOException