com.facebook.buck.skylark.io.impl

Class WatchmanGlobber

java.lang.Object

com.facebook.buck.skylark.io.impl.WatchmanGlobber

public class WatchmanGlobber
extends Object

An implementation of globbing functionality that allows resolving file paths based on include patterns (file patterns that should be returned) minus exclude patterns (file patterns that should be excluded from the resulting set) using Watchman tool for improved performance.

The implementation is mostly compatible with glob_watchman.py and as such differs from the NativeGlobber in certain ways:

• does not fail for patterns that cannot possibly match
• does not collapse multiple slashes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WatchmanGlobber.Option Watchman options to use when globbing.

Method Summary

Modifier and Type	Method and Description
static WatchmanGlobber	create(WatchmanClient watchmanClient, SyncCookieState syncCookieState, String basePath, String watchmanWatchRoot) Factory method for creating WatchmanGlobber instances.
Optional<com.google.common.collect.ImmutableSet<String>>	run(Collection<String> include, Collection<String> exclude, boolean excludeDirectories)
Optional<com.google.common.collect.ImmutableSet<String>>	run(Collection<String> include, Collection<String> exclude, EnumSet<WatchmanGlobber.Option> options)
Optional<com.google.common.collect.ImmutableSet<String>>	run(Collection<String> include, Collection<String> exclude, WatchmanGlobber.Option option)

Methods inherited from class java.lang.Object

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

Method Detail

run

public Optional<com.google.common.collect.ImmutableSet<String>> run(Collection<String> include,
                                                                    Collection<String> exclude,
                                                                    boolean excludeDirectories)
                                                             throws IOException,
                                                                    InterruptedException

Parameters:

include - File patterns that should be included in the resulting set.

exclude - File patterns that should be excluded from the resulting set.

excludeDirectories - Whether directories should be excluded from the resulting set.

Returns:

The set of paths resolved using include patterns minus paths excluded by exclude patterns.

Throws:

IOException

InterruptedException

See Also:

run(Collection, Collection, EnumSet)

run

public Optional<com.google.common.collect.ImmutableSet<String>> run(Collection<String> include,
                                                                    Collection<String> exclude,
                                                                    WatchmanGlobber.Option option)
                                                             throws IOException,
                                                                    InterruptedException

Throws:

IOException

InterruptedException

run

public Optional<com.google.common.collect.ImmutableSet<String>> run(Collection<String> include,
                                                                    Collection<String> exclude,
                                                                    EnumSet<WatchmanGlobber.Option> options)
                                                             throws IOException,
                                                                    InterruptedException,
                                                                    WatchmanQueryFailedException

Parameters:

include - File patterns that should be included in the resulting set.

exclude - File patterns that should be excluded from the resulting set.

options - Customizations for matching behavior.

Returns:

The set of paths resolved using include patterns minus paths excluded by exclude patterns.

Throws:

WatchmanQueryFailedException - Watchman returned an error response.

IOException

InterruptedException

create

public static WatchmanGlobber create(WatchmanClient watchmanClient,
                                     SyncCookieState syncCookieState,
                                     String basePath,
                                     String watchmanWatchRoot)

Factory method for creating WatchmanGlobber instances.

Parameters:

basePath - The base path relative to which paths matching glob patterns will be resolved.